Command reference
deployments thread
Conversation threads
| Command | Summary |
|---|---|
deployments thread list | List conversation threads |
deployments thread create | Create a conversation thread |
deployments thread show | Show a thread |
deployments thread archive | Archive a conversation thread |
deployments thread erase | Permanently erase a thread and everything derived from it |
deployments thread erasure-status | Show a thread erasure |
deployments thread messages | List thread messages |
deployments thread session | Create a bounded thread stream session |
deployments thread list
List conversation threads.
deployments thread list- Calls
GET /v1/threads(SDKlistThreads). - Needs an environment:
--envor the saved context. - Paginated.
--page-sizesets the page size; pass the returned cursor as--cursorfor the next page.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--cursor | string (cursor) | Pagination cursor | ||
--page-size | string (number) | Page size | ||
--execution-binding-id | string | Preview 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(SDKcreateThread). - Needs an environment:
--envor the saved context.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--agent-deployment-id | string | yes | Agent deployment ID | |
--end-user-id | string | Your ID for the end user the thread belongs to | ||
--title | string | Thread title | ||
--workspace-id | string | Workspace ID |
Also accepts the global flags.
deployments thread show
Show a thread.
deployments thread show <id>- Calls
GET /v1/threads/{threadId}(SDKgetThread). - Needs an environment:
--envor the saved context.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID |
Also accepts the global flags.
deployments thread archive
Archive a conversation thread.
deployments thread archive <id>- Calls
POST /v1/threads/{threadId}/archive(SDKarchiveThread). - Needs an environment:
--envor the saved context. - Destructive. Live runs ask for confirmation; pass
--yesin scripts or with--json.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource 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(SDKeraseThread). - Needs an environment:
--envor the saved context. - Destructive. Live runs ask for confirmation; pass
--yesin scripts or with--json.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID |
Also accepts the global flags.
deployments thread erasure-status
Show a thread erasure.
deployments thread erasure-status <id> --thread <thread>- Calls
GET /v1/threads/{threadId}/erasures/{erasureId}(SDKgetThreadErasure). - Needs an environment:
--envor the saved context.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID | |
--thread | string | yes | Thread ID |
Also accepts the global flags.
deployments thread messages
List thread messages.
deployments thread messages <id>- Calls
GET /v1/threads/{threadId}/messages(SDKlistThreadMessages). - Needs an environment:
--envor the saved context. - Paginated.
--page-sizesets the page size; pass the returned cursor as--cursorfor the next page.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--cursor | string (cursor) | Pagination cursor | ||
--page-size | string (number) | Page size | ||
<id> | positional | yes | Resource ID |
Also accepts the global flags.
deployments thread session
Create a bounded thread stream session.
deployments thread session <id>- Calls
POST /v1/threads/{threadId}/stream-sessions(SDKcreateThreadStreamSession). - Needs an environment:
--envor the saved context. - Output contains secrets. They are redacted unless you pass
--reveal.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID |
Also accepts the global flags.