Needs the
agents:read scope.Path parameters
Request
Response
200 OK — the plan. A plan has the agent, the contact and deal it is for, what started it (trigger, with trigger_excerpt — the customer’s words or your note), its goal and rationale, and its steps. contact.uuid is the contact’s id everywhere else in the API. approval_reasons say what needs approval, and expires_at when an unanswered plan is dropped. decided_by and decision_note record the decision (decided_by is null when it was made through the API), and last_error why it stopped or failed. tokens and model are what planning used. scope is contact for a plan for one contact; a broadcast plan has audience and campaign_id, and a story’s has story_id.
Each step has its action, a readable title, body and detail, the agent’s reason, when it runs (run_at), whether it requires_approval, its status and result, its params, and which of them can be changed before approving (editable).
status is one of:
Errors
Every refusal is{"error": {"code", "message", "field"}}; field is there when one input is at fault.
Any request can also be refused for its key, its account or its rate (
key_required, invalid_key, account_suspended, plan_excludes_api, address_not_allowed, rate_limited); see the overview.