Create a document

Knowledge module

POST/documentsdocuments.create

A document with versions. Files are stored in tenant-scoped storage. Creates a document. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Requires the capability knowledge.document.write.
OAuth scopes: knowledge.
Send an Idempotency-Key header. A replay with the same key returns the original response.
Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: DocumentCreate

documents.create: DocumentCreate
Field	Type	Required	Description
title	string	Yes	Document title.Constraints: length 1 to 300
project_id	string (uuid) \| null	No	Identifier of the project.

{
  "title": "Venue Site Plan",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Response 201: Document

documents.create: Document
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the document.
org_id	string (uuid)	Yes	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Yes	When the row was created.
created_by	string (uuid) \| null	Yes	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Yes	When the row was last updated.
updated_by	string (uuid) \| null	Yes	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
title	string	Yes	Document title.Constraints: length 1 to 300
project_id	string (uuid) \| null	Yes	Identifier of the project.

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "title": "Venue Site Plan",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Code samples

curl -X POST "$XOS_BASE_URL/documents" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"title":"Venue Site Plan","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'

const { data } = await xos.documents.create({
    "title": "Venue Site Plan",
    "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
  });

response = xos.documents.create({"title": "Venue Site Plan", "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"})

xos documents create --data '{"title":"Venue Site Plan","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'