Skip to main content
POST
Escalate to a human

Authorizations

Authorization
string
header
required

Access token issued by gtm.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Body

application/json

Request body of escalate_to_human.

subject
string
required

One-line issue title, in the user's language.

Required string length: 3 - 255
body
string
required

The escalation the team will read: user's ask in their words + entities involved + what was tried. User's language for their words; English for the context block.

Required string length: 10 - 16000
reason
enum<string>

Default user_requested. Use copilot_unable when escalating on your own judgment.

Available options:
user_requested,
copilot_unable,
other
copilot_session_sid
string

The current copilot session sid; pass it when escalating from a session (enables retry-dedup).

Required string length: 18
Pattern: ^cp_ss_

Response

create success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
create
item
object
required
already_exists
boolean
required
meta
object
required