Skip to main content
POST
Run Outcome
Runs the outcome’s current script on a single conversation and returns the result. Use it to test a script, or to re-run an outcome on a past call. To run it on more conversations, send one request per conversation. Each run is saved, so you can read it back later with List Outcome Runs.

Headers

string
required
Your API key for authentication.

Path Parameters

string
required
The outcome ID.

Body Parameters

string
required
The call ID or SMS conversation ID to run the outcome on.
string
required
One of CALL, CALL_TEST, PATHWAY or PERSONA. Use CALL_TEST to mark the run as a test. The other values save the run as CALL, or as SMS for an SMS conversation.

Response

object | null
The run result. null when no call or SMS conversation with that ID exists in your organization.
null | array
null on success, otherwise an array of error objects.

Docs for agents: llms.txt