List Scenarios

List paginated scenarios with optional search and filtering by agent definition or agent type. Returns scenario type, status, dataset row count, and creation timestamp.

GET https://api.futureagi.com/simulate/scenarios/

Authentication

X-Api-Key API Key Required

Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the Dashboard under Settings.

X-Secret-Key Secret Key Required

Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the Dashboard.

Query parameters

search string Optional

Case-insensitive filter against scenario name, source, and type.

agent_definition_id string Optional

Filter by agent definition UUID.

agent_type string Optional

Filter by agent type: "voice" or "text".

page integer Optional

Page number, starting from 1. Default: 1.

limit integer Optional

Results per page. Default: 10.

Response

200 OK
count integer
Total matching scenarios.
next string | null
URL of the next page, or null.
previous string | null
URL of the previous page, or null.
results array
Array of scenario objects.
id string
UUID of the scenario.
name string
Scenario name.
description string
Scenario description.
source string
Data source label.
scenario_type string
"dataset" | "script" | "graph".
scenario_type_display string
Human-readable scenario type label.
source_type string
"agent_definition" | "prompt".
source_type_display string
Human-readable source type label.
organization string
Organization UUID.
dataset string | null
UUID of the underlying dataset. null if none.
dataset_rows integer
Number of test case rows. 0 if no dataset.
dataset_column_config object
Map of column ID → {name, type}. [] if no dataset.
graph object
Conversation graph data. {} if none.
agent object | null
Simulator agent object. null if none.
agent_type string | null
"inbound" | "outbound" | "chat" | "prompt" | null.
prompt_template string | null
Prompt template UUID. null if none.
prompt_template_detail object | null
Prompt template details. null if none.
prompt_version string | null
Prompt version UUID. null if none.
prompt_version_detail object | null
Prompt version details. null if none.
status string
Processing status (e.g. "Processing", "Completed", "Failed").
deleted boolean
Whether the scenario is soft-deleted.
deleted_at datetime | null
Deletion timestamp. null if not deleted.
created_at datetime
ISO 8601 creation timestamp.
updated_at datetime
ISO 8601 last-modified timestamp.

Errors

401 Unauthorized Optional

Invalid or missing API credentials.

404 Not Found Optional

Organization not found for the authenticated user.

{"error": "Organization not found for the user."}
500 Internal Server Error Optional

Unexpected server error.

{"error": "Failed to retrieve scenarios: <message>"}
GET /
Authentication
REQUEST 
 
 
  
 
 RESPONSE