Skip to main content
POST
Compose agent brief

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.

Path Parameters

sid
string
required

The agent whose Brief it is (ub_ag_…).

Required string length: 18
Pattern: ^ub_ag_

Body

application/json

Request body of compose_agent_brief.

said
string | null

What the person asked for, as they said it; left out, the Brief is only made clearer.

Maximum string length: 16384
current
string | null

The Brief as the editor holds it when it is not saved yet; left out, the stored Brief.

Maximum string length: 49152

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