Get Scenario

Retrieve a scenario by UUID. Returns scenario type, dataset ID, agent type, status, conversation graph, simulator prompts, and dataset row count.

GET https://api.futureagi.com/simulate/scenarios/{scenario_id}/

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.

Path parameters

scenario_id UUID Required

The scenario ID.

Response

200 OK
id string
UUID of the scenario.
name string
Scenario name.
description string
Scenario description.
source string
Data source used to create the scenario.
scenario_type string
Type: "dataset", "script", or "graph".
dataset_id string | null
UUID of the underlying dataset. null if none.
organization string
Organization UUID.
dataset string | null
UUID of the underlying dataset (same as dataset_id). null if none.
agent_type string | null

Raw agent type value: "voice" or "text". null if undetermined.

Note: This endpoint returns the raw AgentDefinition.agent_type value ("voice" or "text"), which differs from the List Scenarios endpoint (which returns "inbound", "outbound", "chat", or "prompt").

status string
Current status (e.g. "Processing", "Completed", "Failed").
graph object
Conversation graph structure. {} if none.
prompts array
Simulator agent prompts.
role string
Prompt role: "system", "user", or "assistant".
content string
Prompt text content.
dataset_rows integer
Number of test case rows. 0 if no dataset.
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

Scenario not found or does not belong to your organization.

{"error": "Scenario not found."}
500 Internal Server Error Optional

Unexpected server error.

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