H2h2o
Documents

Updates attributes of an existing document.

Updates attributes of an existing document, particularly name and uri.

patch/documents/{document_id}

Request

Path parameters

document_idstring required

Id of document to to be updated

Request body

namestring
uristring

Response

Successful operation

idstring required

A unique identifier of the document

namestring required

Name of the document

usernamestring required

A username owning the document

typestring required

Type of the document

sizeinteger required

Size of the document in bytes

page_countinteger required

A number of pages contained in the document

status'unknown' | 'scheduled' | 'queued' | 'running' | 'completed' | 'failed' | 'canceled' | 'agent_only' required

Status of the document

usage_statsstring

Usage stats

connectorstring
original_typestring
original_mtimestring datetime
created_atstring date-time required

Time when document was created

updated_atstring date-time required

Last time when document was modified

uristring
summarystring
summary_parametersstring
metadata_dictMetadata
is_encryptedboolean

Whether the document files are encrypted at rest

chat_session_idstring

A unique identifier of the chat session that generated the document. Returned by GET /documents. Only set for agent-generated files, null for user-uploaded documents.

chat_session_namestring

Name of the chat session that generated the document. Returned by GET /documents. Null when the document was not generated by an agent, or when the session is not visible to the caller.

chat_session_visibleboolean

Whether the caller can open the chat session that generated the document. Returned by GET /documents. Distinct from chat_session_name being null, which also happens when a visible session has no name yet.

Example response

{
  "id": "123e4567-e89b-12d3-a456-426655440000",
  "name": "The Hitchhiker's Guide to the Galaxy",
  "chat_session_id": "123e4567-e89b-12d3-a456-426655440000"
}

Changes

No recorded changes to this operation across all 1 revision of this API.