Brains
Capture a Brain document revision
POST /v1/brains/{brainId}/sources/{sourceId}/documents · SDK captureBrainDocument · CLI deployments brain-document capture
POST
Requires brains:write.
tenantJwtheader
AuthorizationBearer <token>Tenant JWT carrying organization, project, and environment claims.
brainId*stringMatch
^[0-7][0-9A-HJKMNP-TV-Z]{25}$sourceId*stringMatch
^[0-7][0-9A-HJKMNP-TV-Z]{25}$x-deployments-organization*stringMatch
^[0-7][0-9A-HJKMNP-TV-Z]{25}$idempotency-key*stringLimited to 500 UTF-8 bytes.
Length
1 <= length <= 500application/json- body
completedUploadTicketId?stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$externalItemIdentity*stringkind*stringValue in
"archive""content""restore""tombstone"mediaType?stringrestoredContentVersionId?stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$sensitivity?stringValue in
"confidential""internal""public""restricted"sourceLocator?stringsourceOrder?integerRange
0 <= valuesourceRevision?stringsourceTimestamp?stringstableVersion?stringtitle?stringtransitionReason?stringBrainDocumentResponse
application/json- response
document*version*curl -X POST "https://example.com/v1/brains/string/sources/string/documents" \ -H "x-deployments-organization: string" \ -H "idempotency-key: string" \ -H "Content-Type: application/json" \ -d '{ "externalItemIdentity": "string", "kind": "archive" }'{ "document": { "brainId": "string", "createdAt": "string", "currentContentVersionId": "string", "currentEnvelopeHash": "string", "currentSourceOrder": 0, "currentVersionId": "string", "externalItemIdentity": "string", "id": "string", "lifecycle": "active", "organizationId": "string", "projectionGeneration": 0, "reviewStatus": "approved", "sensitivity": "confidential", "sourceId": "string", "sourceLocator": "string", "title": "string", "updatedAt": "string", "version": 0 }, "version": { "bodyRef": { "bucket": "string", "byteSize": 0, "contentType": "string", "etag": "string", "fileName": "string", "key": "string", "sha256": "string", "versionId": "string" }, "brainId": "string", "byteSize": 0, "contentHash": "string", "createdAt": "string", "documentId": "string", "envelopeHash": "string", "id": "string", "kind": "archive", "language": "string", "mediaType": "string", "organizationId": "string", "originalRenditionId": "string", "predecessorVersionId": "string", "restoredContentVersionId": "string", "sourceId": "string", "sourceOrder": 0, "sourceRevision": "string", "sourceTimestamp": "string", "transitionReason": "string" }}