Skip to main content
POST
Preview Scenario Prompt

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
string
required

Tuner's numeric agent ID, or your Agent ID from Agent Settings > Agent Connection. Digits-only values are read as the numeric ID.

workspace_id
integer
required

Workspace ID. Find this in Workspace > General Settings.

Body

application/json

Scenario fields to preview the prompt for.

situation
string
default:""

Situation the simulated caller is in, up to 8000 characters. May be empty.

Maximum string length: 8000
Example:

"The caller was charged twice for the same order and wants one charge refunded."

goal
string | null

What the caller is trying to achieve, up to 2000 characters.

Maximum string length: 2000
Example:

"Get the duplicate charge refunded."

first_line
string | null

Exact opening line the caller speaks first, up to 500 characters.

Maximum string length: 500
Example:

"Hi, I think I was charged twice for my last order."

stop_condition
string | null

When the caller should hang up, up to 1000 characters.

Maximum string length: 1000
Example:

"The agent confirms the refund or says it cannot be done."

Response

Successful Response

The previewed scenario prompt.

sections
ScenarioPromptPreviewSection · object[]
required

The prompt split into labelled parts. Optional fields left empty are omitted.

prompt
string
required

The full prompt text, as it would be used for a simulated call.