Deployments.ai Docs
Command reference

deployments preview

Unpublished agent manifest previews

CommandSummary
deployments preview createCreate a preview from an unpublished agent manifest
deployments preview showShow a preview
deployments preview deleteExpire a preview
deployments preview turnSubmit a turn to a preview

deployments preview create

Create a preview from an unpublished agent manifest.

deployments preview create
  • Calls POST /v1/previews (SDK createPreview).
  • Needs an environment: --env or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
--manifeststring (json)Agent manifest JSON
--manifest-filestringLocal agent manifest JSON file
--runtime-configstring (json)Preview runtime configuration JSON
--runtime-config-filestringLocal runtime configuration JSON file
--from-agent-deployment-idstringAgent deployment whose runtime configuration to reuse
--ttl-secondsstring (number)Preview lifetime in seconds (60-604800)

Also accepts the global flags.

deployments preview show

Show a preview.

deployments preview show <id>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID

Also accepts the global flags.

deployments preview delete

Expire a preview.

deployments preview delete <id>
  • Calls DELETE /v1/previews/{previewId} (SDK deletePreview).
  • Needs an environment: --env or the saved context.
  • Destructive. Live runs ask for confirmation; pass --yes in scripts or with --json.
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID

Also accepts the global flags.

deployments preview turn

Submit a turn to a preview.

deployments preview turn <id> --message <message>
  • Calls POST /v1/previews/{previewId}/turns (SDK submitPreviewTurn).
  • Needs an environment: --env or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID
--threadstringThread ID
--messagestringyesMessage input

Also accepts the global flags.

On this page