Deployments.ai Docs
Command reference

deployments brain

Governed company and member-private knowledge Brains

CommandSummary
deployments brain searchSearch source-grounded Brain evidence
deployments brain askAsk a cited question across authorized Brains
deployments brain listList visible Brains
deployments brain createCreate a Brain
deployments brain showShow a Brain
deployments brain index-healthList Brain document index health
deployments brain updateUpdate a Brain
deployments brain archiveArchive a Brain

Search source-grounded Brain evidence.

deployments brain search --brains <a-b-c> --query <query>
  • Calls POST /v1/brains/search (SDK searchBrains).
  • Needs an organization, project, and environment: --org, --project, --env, or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
--brainsstring (a,b,c)yesBrain IDs
--limitstring (number)Maximum evidence results
--querystringyesEvidence query

Also accepts the global flags.

deployments brain ask

Ask a cited question across authorized Brains.

deployments brain ask --brains <a-b-c> --question <question>
  • Calls POST /v1/brains/ask (SDK askBrains).
  • Needs an organization, project, and environment: --org, --project, --env, or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
--brainsstring (a,b,c)yesBrain IDs
--evidence-limitstring (number)Maximum evidence results
--questionstringyesQuestion

Also accepts the global flags.

deployments brain list

List visible Brains.

deployments brain list
  • Calls GET /v1/brains (SDK listBrains).
  • Needs an organization: --org or the saved context.
  • Paginated. --page-size sets the page size; pass the returned cursor as --cursor for the next page.
FlagTypeRequiredDefaultDescription
--cursorstring (cursor)Pagination cursor
--page-sizestring (number)Page size
--statusstringBrain status

Also accepts the global flags.

deployments brain create

Create a Brain.

deployments brain create --kind <kind> --name <name> --slug <slug>
  • Calls POST /v1/brains (SDK createBrain).
  • Needs an organization: --org or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
--kindstringyesBrain kind: company or member-private
--namestringyesBrain name
--sensitivitystringDefault sensitivity
--slugstringyesOrganization-unique Brain slug

Also accepts the global flags.

deployments brain show

Show a Brain.

deployments brain show <brain>
FlagTypeRequiredDefaultDescription
<brain>positionalyesBrain ID

Also accepts the global flags.

deployments brain index-health

List Brain document index health.

deployments brain index-health <brain>
  • Calls GET /v1/brains/{brainId}/index-health (SDK listBrainIndexHealth).
  • Needs an organization: --org or the saved context.
  • Paginated. --page-size sets the page size; pass the returned cursor as --cursor for the next page.
FlagTypeRequiredDefaultDescription
--cursorstring (cursor)Pagination cursor
--page-sizestring (number)Page size
<brain>positionalyesBrain ID

Also accepts the global flags.

deployments brain update

Update a Brain.

deployments brain update <brain> --expected-version <number>
  • Calls PATCH /v1/brains/{brainId} (SDK updateBrain).
  • Needs an organization: --org or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
<brain>positionalyesBrain ID
--expected-versionstring (number)yesCurrent Brain version
--maintenance-policystring (json)Maintenance policy
--namestringBrain name
--retrieval-policystring (json)Retrieval policy
--sensitivitystringDefault sensitivity
--slugstringOrganization-unique Brain slug

Also accepts the global flags.

deployments brain archive

Archive a Brain.

deployments brain archive <brain> --expected-version <number>
  • Calls DELETE /v1/brains/{brainId} (SDK archiveBrain).
  • Needs an organization: --org or the saved context.
  • Destructive. Live runs ask for confirmation; pass --yes in scripts or with --json.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
<brain>positionalyesBrain ID
--expected-versionstring (number)yesCurrent Brain version

Also accepts the global flags.

On this page