Skip to main content
POST
/
v1
/
orgs
/
{org_id}
/
scenarios
/
{scenario_id}
/
run
Run Scenario
curl --request POST \
  --url https://api.letpiper.com/v1/orgs/{org_id}/scenarios/{scenario_id}/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "scenario_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "pending",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "session_id": "<string>",
  "cost_summary": {},
  "error_message": "<string>",
  "turn_results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "turn_index": 123,
      "stopped_early": true,
      "passed": true,
      "response_content": "<string>",
      "criteria_results": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "criteria_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "verdict": "PASS",
          "critique": "<string>",
          "evidence": "<string>",
          "input_tokens": 123,
          "output_tokens": 123
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Platform token (starts with pat_)

Path Parameters

​
org_id
string<uuid>
required
​
scenario_id
string<uuid>
required

Body

application/json

Schema for creating a scenario run.

​
agent_id
string<uuid>
required

ID of the agent to test

Response

Successful Response

Schema for reading a scenario run.

​
id
string<uuid>
required
​
scenario_id
string<uuid>
required
​
agent_id
string<uuid>
required
​
status
enum<string>
required

Status of a scenario run.

Available options:
pending,
running,
passed,
failed,
error
​
started_at
string<date-time> | null
required
​
completed_at
string<date-time> | null
required
​
session_id
string | null
​
cost_summary
Cost Summary · object
​
error_message
string | null
​
turn_results
ScenarioTurnResultRead · object[]