Update Document

POST

/org/:org_id/project/:project_id/document/:document_id

POST

/api/v1/org/:org_id/project/:project_id/document/:document_id

$ curl -X POST https://app.rightbrain.ai/api/v1/org/org_id/project/project_id/document/document_id \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "title": "Driver Safety SOP — Revised"
> }'

1 {
2   "title": "Driver Safety SOP — Revised",
3   "project_id": "019a2f10-8b2d-7e43-9c64-1c9d4e7b6f02",
4   "strategy": "pdf",
5   "id": "019a2f10-b1b6-7e60-95fd-1c9d4e7b6f30",
6   "chunks": 42,
7   "original_mime": "application/pdf",
8   "embedding_instances": [
9     {
10       "id": "019a2f10-c1d8-7e70-971f-1c9d4e7b6f40",
11       "chat_document_id": "019a2f10-b1b6-7e60-95fd-1c9d4e7b6f30",
12       "is_active": true,
13       "config": {}
14     }
15   ],
16   "description": "Standard operating procedure for pre-trip vehicle checks and incident reporting.",
17   "source": "upload",
18   "source_meta": {},
19   "connection_id": null
20 }

Update document metadata such as title or description.

Allows modification of:

Document title
Description

Does not re-process the document content or embeddings.

Update document metadata such as title or description. Allows modification of: - Document title - Description Does not re-process the document content or embeddings.

Authentication

AuthorizationBearer

API key or access token, sent as Authorization: Bearer <token>. The simplest option: create an API key in your dashboard under Settings, then paste it here.

AuthorizationBearer

API key or access token, sent as Authorization: Bearer <token>. The simplest option: create an API key in your dashboard under Settings, then paste it here.

Path parameters

document_idstringRequiredformat: "uuid"

The UUID of the document

org_idstringRequiredformat: "uuid"

The unique identifier of the organization.

project_idstringRequiredformat: "uuid"

The unique identifier of the project.

Request

This endpoint expects an object.

titlestringRequired

descriptionstring or nullOptional

Response

Document updated successfully

titlestring

project_idstringformat: "uuid"

strategystring

idstringformat: "uuid"

chunksinteger

original_mimestring

embedding_instanceslist of objects or null

descriptionstring or nullOptional

sourceenum or nullOptional

Source types for documents in the system.

source_metamap from strings to any or nullOptional

connection_idstring or nullOptionalformat: "uuid"

Errors

400

Bad Request Error

403

Forbidden Error

422

Unprocessable Entity Error