Skip to main content
POST
Steer agent plan

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 live plan to rewrite (proposed or active: an approved plan is rewritten too, and its own steps wait while the rewrite is written).

Required string length: 18
Pattern: ^ub_pl_

Body

application/json

Request body of steer_agent_plan.

guidance
string
required

What should change, in one line, the way you would tell a colleague (no booking link yet, answer the question and ask about their carriers). Max 1000 chars. The agent changes what this names and keeps every other step as it stands.

Required string length: 1 - 1000
step_id
integer | null

The one message the guidance is about: the id of an unrun send_message step of this plan. The agent rewrites that message (and its intent) and keeps every other step, a counting wait included. 422 not_a_message_step otherwise. Omit = the whole plan.

Required range: x >= 1

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
object | null
required
result
object
required
meta
object
required