Skip to main content
GET
List Scenarios

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.

Query Parameters

q
string | null

Case-insensitive substring match across name, situation, goal, first_line, and tags.

Maximum string length: 200
type
enum<string> | null

Restrict to this scenario type. Omitted returns all types.

Available options:
routine,
pressure
tag
string | null

Exact, case-sensitive match on one of the scenario's tags. Combines with q and type.

Maximum string length: 200

Response

Successful Response

Response schema for a list of library scenarios.

scenarios
ScenarioResponse · object[]

The agent's scenarios, newest first.