Archive a conversation thread
POST /v1/threads/{threadId}/archive · SDK archiveThread · CLI deployments thread archive
Requires runs:write.
AuthorizationBearer <token>Opaque bearer credential scoped to one service account and tenant.
threadId*string^[0-7][0-9A-HJKMNP-TV-Z]{25}$x-deployments-environment?stringRequired with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.
^[0-7][0-9A-HJKMNP-TV-Z]{25}$x-deployments-organization?stringRequired with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.
^[0-7][0-9A-HJKMNP-TV-Z]{25}$x-deployments-project?stringRequired with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.
^[0-7][0-9A-HJKMNP-TV-Z]{25}$ThreadResponse
application/json- response
createdAt*string^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$date-timeupdatedAt*string^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$date-timeversion*number|||environmentId*string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$organizationId*string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$projectId*string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$workspaceId?string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$agentDeploymentId?string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$archived*booleanchannel*stringcontinuedFromThreadId?string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$createdBy*executionBindingId?string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$executionPurpose*string"customer""evaluation""preview"externalThreadKey?stringid*string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$object*"thread""thread"pinned*booleanpinnedAgentReleaseId?string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$streamId*string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$title*stringcurl -X POST "https://example.com/v1/threads/string/archive"{ "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "version": 0, "environmentId": "string", "organizationId": "string", "projectId": "string", "workspaceId": "string", "agentDeploymentId": "string", "archived": true, "channel": "string", "continuedFromThreadId": "string", "createdBy": { "id": "string", "type": "agent" }, "executionBindingId": "string", "executionPurpose": "customer", "externalThreadKey": "string", "id": "string", "object": "thread", "pinned": true, "pinnedAgentReleaseId": "string", "streamId": "string", "title": "string"}