Skip to main content
POST
Cancel a collection

Authorizations

Authorization
string
header
required

Send Authorization: Bearer <THRED_API_KEY>. Development keys begin thr_dev_; Production keys begin thr_prod_. Each key is scoped to a workspace and environment. Keep secrets on your server.

Path Parameters

id
string
required

The collection ID returned when the request was accepted. IDs use the call_ prefix.

Pattern: ^call_[a-z0-9-]+$

Response

Cancellation recorded, or the current state of an already closed or cancel-requested collection.

Current collection state. Retrieve the collection to confirm it reaches a terminal status.

id
string
required

The collection ID, using the call_ prefix.

Example:

"call_123e4567-e89b-42d3-a456-426614174000"

environment
enum<string>
required

The API key selects the workspace environment. Development and Production are isolated, but either can place real calls when enabled.

Available options:
development,
production
status
enum<string>
required

Final: completed, incomplete, failed, canceled. Continue polling for all other statuses.

Available options:
queued,
dialing,
in_progress,
processing,
awaiting_review,
completed,
incomplete,
failed,
canceled
handling
enum<string>
required

Who is handling the call: AI, waiting for an internal operator, or an internal operator.

Available options:
ai,
awaiting_operator,
operator
to
string
required

Destination in E.164 format.

Example:

"+14155550123"

from
string
required

Outbound caller number in E.164 format.

Example:

"+12025550124"

created_at
string<date-time>
required

UTC creation time.

updated_at
string<date-time>
required

UTC time of the latest update.

started_at
string<date-time> | null
required

UTC job start time, or null before startup.

ended_at
string<date-time> | null
required

UTC job end time, or null until closure. Results may still be processing afterward.

human_assisted
boolean
required

Whether an internal operator assisted the live call. Assisted results require approval before publication.

outcome
string | null
required

Call closure reason, when known. Use status to determine whether results are final.

data
object | null
required

Complete answers matching output, or null before publication / when no complete result exists.

partial_data
object | null
required

Available answers when a complete result could not be obtained. Missing required fields may be omitted, but remaining schema constraints still apply.

missing_fields
string[]
required

Validation messages for unavailable answers, including the field path. Empty for completed and canceled collections.

error
object | null
required

Collection failure details. This is separate from an HTTP error response.

duration_seconds
number | null
required

Elapsed job duration; not provider billable talk time.

usage
object
required
recording_status
enum<string>
required

Recording progresses independently of the call result. Hosted recording is currently disabled.

Available options:
disabled,
pending,
starting,
recording,
processing,
ready,
failed
recording
object
required
cancellation_requested
boolean
required

True once a cancellation request is recorded; does not by itself mean the call has ended.

screener_sequence
object[] | null
required

Prepared or supplied screener messages, or null while preparation is pending.

screener_sequence_source
enum<string> | null
required

Whether screener messages were supplied or generated.

Available options:
provided,
generated,
null
navigation_cache_source_call_id
string | null
required

Prior call whose eligible navigation steps were loaded, or null.

request
object
required

The accepted request with defaults applied and text normalized. Client metadata remains available here.

navigation_routes
object[]

Included when the call is already closed, terminal, or previously marked for cancellation.

Maximum array length: 16