Skip to main content
POST
Handoff conversation from AI to a human

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

Idempotency-Key
string

Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.

Required string length: 1 - 255
X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Path Parameters

id
string
required

Body

application/json
reason
string

Short reason — surfaced to the receiving human (e.g. 'asked for a manager').

Maximum string length: 500
target_queue
string

Optional queue to route to. Defaults to the tenant's default queue.

Maximum string length: 100
reason_category
enum<string>

Machine-readable handoff category for analytics. When omitted, inferred from the free-text reason.

Available options:
cant_understand,
policy_block,
customer_request,
tool_failed,
escalation_threshold,
manual
skill_tags
string[]

Caller override for the skill set used to match operators. When omitted, derived from the conversation's most recent AI agent's skill_tags.

Maximum array length: 20
Maximum string length: 40
brief
string

Caller-supplied 2-3 sentence summary. When omitted, the service generates one via the LLM gateway.

Maximum string length: 600

Response

Successful response.