Command reference
deployments brain-document
Immutable Brain document revisions
| Command | Summary |
|---|---|
deployments brain-document capture | Capture a Brain document revision |
deployments brain-document show | Show a Brain document and current immutable version |
deployments brain-document capture
Capture a Brain document revision.
deployments brain-document capture <brain> <source> --external-item-identity <external-item-identity> --kind <kind>- Calls
POST /v1/brains/{brainId}/sources/{sourceId}/documents(SDKcaptureBrainDocument). - Needs an organization:
--orgor the saved context. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<brain> | positional | yes | Brain ID | |
<source> | positional | yes | Brain source ID | |
--completed-upload-ticket-id | string | Completed upload ticket ID | ||
--external-item-identity | string | yes | Stable source item identity | |
--kind | string | yes | Revision kind | |
--media-type | string | Content media type | ||
--restored-content-version-id | string | Retained content version ID | ||
--sensitivity | string | Document sensitivity | ||
--source-locator | string | Canonical source locator | ||
--source-order | string (number) | Monotonic source order | ||
--source-revision | string | Source revision | ||
--source-timestamp | string | Source timestamp | ||
--stable-version | string | Provider stable version or ETag | ||
--title | string | Document title | ||
--transition-reason | string | Lifecycle transition reason |
Also accepts the global flags.
deployments brain-document show
Show a Brain document and current immutable version.
deployments brain-document show <brain> <document>- Calls
GET /v1/brains/{brainId}/documents/{documentId}(SDKgetBrainDocument). - Needs an organization:
--orgor the saved context.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<brain> | positional | yes | Brain ID | |
<document> | positional | yes | Brain document ID |
Also accepts the global flags.