Update Document
Update a document’s document_name and tags.
https://docs.tavus.io/openapi.yaml for the full HTTP API contract.Authorizations
Path Parameters
The unique identifier of the document to update
Body
Response
Document updated successfully
Unique identifier for the document
"d8-5c71baca86fc"
Updated name of the document
"Updated Document Name"
URL of the document
"https://docs.example.com/"
Current status of the document processing. Possible values: started, processing, ready, error, recrawling.
started, processing, ready, error, recrawling "ready"
Processing progress as a percentage (0-100). Null when processing has not started or is complete.
null
Error code indicating why processing failed. Only present when status is error. Possible values include: file_download_failed, file_format_unsupported, file_size_too_large, file_empty, invalid_file_url, document_processing_failed, website_processing_failed, chunking_failed, embedding_failed, vector_store_failed, contact_support.
ISO 8601 timestamp of when the document was created
"2024-01-01T12:00:00Z"
ISO 8601 timestamp of when the document was last updated
"2024-01-01T13:00:00Z"
URL that receives status updates
"https://your-server.com/webhook"
Updated array of document tags
The crawl configuration used for this document (only present for crawled websites)
List of URLs that were crawled (only present for crawled websites after processing completes)
ISO 8601 timestamp of when the document was last crawled
"2024-01-01T12:00:00Z"
Number of times the document has been crawled
1

