Sign in

v1

latestOpenAPI 3.1.02026-07-2268276396.6 KB
Documents

Update document metadata

Partially update a document's metadata. Send only the fields you want to change.

  • tags: Array of tag IDs (UUIDs) to assign to the document. This replaces the document's current tag set, so you can add or remove tags by including the full list you want applied. Each ID must refer to an existing tag (use POST /contents/v1/tags to create one, or GET /contents/v1/tags to list IDs). If any ID is invalid, the API returns 400 with error code INVALID_TAGS_ERROR.
  • share_with_org: When true, the document is available to all members of your organization. When false, only you can access it.
patch/contents/v1/documents/{content_id}

Path parameters

content_idstring required
Example:E0618D0E9D3A960C1731A620EDE56B5C

Content ID of the document to update (32-character uppercase hexadecimal string).

Request body

tagsstring[]

Tag IDs to assign to the document. Replaces the current tag assignment. Every ID must exist; otherwise the API returns INVALID_TAGS_ERROR.

share_with_orgboolean

If true, all members of your organization can access the document. If false, only you can access it.

Example request

{
  "tags": [
    "019e3a99-6952-7dd4-adf5-b0b341959e11"
  ]
}

Response

Updated document metadata.

idstring required

Content ID: unique 32-character uppercase hexadecimal identifier for the document. Use this when calling Get document, Get annotated document, or Get original document.

file_namestring required

Original file name of the uploaded document.

user_idstring required

ID of the user who uploaded the document.

org_idstring required

ID of the organization the document belongs to.

rp_collection_idstring

ID of the collection the document belongs to. This is applicable only for emails and attachments.

raw_sizeinteger

Size of the raw document in bytes.

request_origin'email' | 'investment_research' | 'sharepoint' | 'file_upload'

Origin of the content ingestion request: how the document entered the platform.

content_typestring

MIME type of the document.

status'pending' | 'processing' | 'completed' | 'failed' required

Processing status of the document.

shared_with_orgsstring[]

List of organization IDs the document is shared with.

created_atstring date-time required

Timestamp when the document was created.

updated_atstring date-time required

Timestamp when the document was last updated.

published_atstring date-time required

Timestamp when the document was published. This is the reference timestamp used for search and retrieval.

connector_idstring uuid

ID of the connector used to upload the document.

error_codestring nullable

Error code if the document processing failed.

delete_started_tsstring date-time nullable

Timestamp when document deletion started, if applicable.

file_metadataobject nullable

Additional metadata about the file.

Example response

{
  "id": "E0618D0E9D3A960C1731A620EDE56B5C",
  "file_name": "Weekly summary report.eml",
  "user_id": "user_id_001",
  "org_id": "org_id_001",
  "rp_collection_id": "2CBDC7DA8AE42A8A078DECC3C9FCADFB",
  "raw_size": 18974,
  "content_type": "message/rfc822",
  "shared_with_orgs": [
    "org_id_001"
  ],
  "created_at": "2026-02-03T08:43:02.729356Z",
  "updated_at": "2026-02-03T08:43:02.729359Z",
  "published_at": "2026-02-03T08:43:02.729359Z",
  "connector_id": "019a9612-bfad-758c-884e-37dd8c6ad2cb",
  "tags": [
    {
      "id": "019a48b4-e574-71d9-a8d9-6a5a86386847",
      "name": "from:user@email.com"
    }
  ]
}