Skip to main content
POST
Compose agent scenario

Authorizations

Authorization
string
header
required

Access token issued by gs.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 compose_agent_scenario.

text
string
required

What the person said, as they said it.

Required string length: 1 - 8192
agent_sid
string

The AI SDR whose scenario it is (ub_ag_…); with a platform key, which agent's version. Left out, the team's default agent.

Required string length: 18
Pattern: ^ub_ag_
sid
string

The scenario the words change; leave it out for a new scenario.

Required string length: 1 - 64

Response

action success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
action
action
string
required

kebab-case verb; matches the route segment.

item
any
required
result
object
required
meta
object
required