Deployments.ai Docs
Command reference

deployments thread

Conversation threads

CommandSummary
deployments thread listList conversation threads
deployments thread createCreate a conversation thread
deployments thread showShow a thread
deployments thread archiveArchive a conversation thread
deployments thread erasePermanently erase a thread and everything derived from it
deployments thread erasure-statusShow a thread erasure
deployments thread messagesList thread messages
deployments thread sessionCreate a bounded thread stream session

deployments thread list

List conversation threads.

deployments thread list
  • Calls GET /v1/threads (SDK listThreads).
  • Needs an environment: --env 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
--execution-binding-idstringPreview or evaluation execution binding ID

Also accepts the global flags.

deployments thread create

Create a conversation thread.

deployments thread create --agent-deployment-id <agent-deployment-id>
  • Calls POST /v1/threads (SDK createThread).
  • Needs an environment: --env or the saved context.
FlagTypeRequiredDefaultDescription
--agent-deployment-idstringyesAgent deployment ID
--end-user-idstringYour ID for the end user the thread belongs to
--titlestringThread title
--workspace-idstringWorkspace ID

Also accepts the global flags.

deployments thread show

Show a thread.

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

Also accepts the global flags.

deployments thread archive

Archive a conversation thread.

deployments thread archive <id>
  • Calls POST /v1/threads/{threadId}/archive (SDK archiveThread).
  • 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 thread erase

Permanently erase a thread and everything derived from it.

deployments thread erase <id>
  • Calls POST /v1/threads/{threadId}/erasures (SDK eraseThread).
  • 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 thread erasure-status

Show a thread erasure.

deployments thread erasure-status <id> --thread <thread>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID
--threadstringyesThread ID

Also accepts the global flags.

deployments thread messages

List thread messages.

deployments thread messages <id>
  • Calls GET /v1/threads/{threadId}/messages (SDK listThreadMessages).
  • Needs an environment: --env 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
<id>positionalyesResource ID

Also accepts the global flags.

deployments thread session

Create a bounded thread stream session.

deployments thread session <id>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID

Also accepts the global flags.

On this page