Skip to main content
GET
/
v1
/
orgs
/
{org_id}
/
scenarios
/
{scenario_id}
/
runs
List Scenario Runs
curl --request GET \
  --url https://api.letpiper.com/v1/orgs/{org_id}/scenarios/{scenario_id}/runs \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "agent_name": "<string>",
    "status": "pending",
    "started_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z",
    "passed_turns": 123,
    "total_turns": 123,
    "session_id": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

Platform token (starts with pat_)

Path Parameters

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

Query Parameters

​
limit
integer
default:50
Required range: 1 <= x <= 500
​
offset
integer
default:0
Required range: x >= 0

Response

Successful Response

​
id
string<uuid>
required
​
agent_id
string<uuid>
required
​
agent_name
string
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
​
passed_turns
integer
required
​
total_turns
integer
required
​
session_id
string | null