Skip to main content
POST
Create Call Outcome

Authorizations

Authorization
string
header
required

Use Tuner API key (tr_api_...) or user session token. Find your API key in Workspace Settings > API Keys.

Path Parameters

agent_id
integer
required

Tuner's internal numeric ID for the agent.

workspace_id
integer
required

Workspace ID. Find this in Workspace > General Settings.

Body

application/json

Input schema for call outcome.

label
string
required

Display name for this outcome, shown on call records and dashboards.

Required string length: 1 - 200
prompt_definition
string
required

Instruction the AI uses to decide whether a call ended this way.

Minimum string length: 1
outcome_type
enum<string>
required

Whether this outcome counts as a success or a failure. Drives the success rate on dashboards and alerts.

Available options:
success,
failure
stop_analysis
boolean
default:false

Skip the remaining analysis steps when a call matches this outcome. Use for outcomes where further grading isn't meaningful, such as a call that never connected.

Response

Successful Response

Response schema for call outcome.

id
integer
required

Unique identifier for the call outcome.

Example:

5

label
string
required

Display name for this outcome, shown on call records and dashboards.

Example:

"Resolved"

prompt_definition
string
required

Instruction the AI uses to decide whether a call ended this way.

Example:

"The caller confirmed their issue was resolved before ending the call."

outcome_type
enum<string>
required

Whether this outcome counts as a success or a failure. Drives the success rate on dashboards and alerts.

Available options:
success,
failure
Example:

"success"

stop_analysis
boolean
required

Skip the remaining analysis steps when a call matches this outcome. Use for outcomes where further grading isn't meaningful, such as a call that never connected.

Example:

false

ui_description
string | null

Optional longer description of the outcome, shown in the UI.

Example:

"The caller's issue was fully resolved on this call."