Skip to main content
POST
/
v1
/
orgs
/
{org_id}
/
scenarios
/
batch-run
Create Batch Run
curl --request POST \
  --url https://api.letpiper.com/v1/orgs/{org_id}/scenarios/batch-run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agent_name": "<string>",
  "status": "queued",
  "total_scenarios": 123,
  "completed_scenarios": 123,
  "passed_scenarios": 123,
  "failed_scenarios": 123,
  "error_scenarios": 123,
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "error_message": "<string>",
  "runs": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "scenario_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "scenario_name": "<string>",
      "status": "pending",
      "passed_turns": 123,
      "total_turns": 123
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Platform token (starts with pat_)

Path Parameters

​
org_id
string<uuid>
required

Body

application/json

Schema for creating a batch run (run all scenarios).

​
agent_id
string<uuid>
required

ID of the agent to test all scenarios against

Response

Successful Response

Full detail of a batch run including per-scenario results.

​
id
string<uuid>
required
​
organization_id
string<uuid>
required
​
agent_id
string<uuid>
required
​
agent_name
string
required
​
status
enum<string>
required

Status of a batch run across all scenarios.

Available options:
queued,
running,
completed,
error
​
total_scenarios
integer
required
​
completed_scenarios
integer
required
​
passed_scenarios
integer
required
​
failed_scenarios
integer
required
​
error_scenarios
integer
required
​
started_at
string<date-time> | null
required
​
completed_at
string<date-time> | null
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
error_message
string | null
​
runs
ScenarioBatchRunItemSummary · object[]