Edit Scenario

Updates a scenario's name, description, graph data, or simulator agent prompt.

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

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.

Request body

name string Optional

Updated scenario name. Max 255 characters. Cannot be blank or whitespace-only.

description string Optional

Updated scenario description.

graph object Optional

Updated conversation graph structure. Replaces the active ScenarioGraph.graph_config.graph_data. If no active graph exists, a new one is created.

prompt string Optional

Updated simulator agent prompt text. Replaces the simulator_agent.prompt field.

Response

200 OK
message string
Confirmation of successful update: "Scenario updated successfully".
scenario object
Updated scenario object (full ScenarioSchema — see List Scenarios for field reference).

Errors

400 Bad Request Optional

Validation error. The response includes an error message and a details object with per-field errors.

{
  "error": "…",
  "details": {
    "name": ["Name cannot be empty or just whitespace."]
  }
}
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 update scenario: <message>"}
GET /
Authentication
REQUEST
 
RESPONSE