Edit Scenario — API

Update a scenario's name, description, conversation graph, or simulator prompt. Supports persona and situation template variables in the prompt field.

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.

description string Optional

Updated scenario description.

graph object Optional

Updated conversation graph structure.

prompt string Optional

Updated simulator agent prompt. Supports {{persona}} and {{situation}} template variables.

Response

200 OK
message string
Confirmation of successful update.
scenario object
Updated scenario object.

Errors

400 Bad Request Optional

Invalid request body, such as an empty name.

401 Unauthorized Optional

Invalid or missing API credentials.

404 Not Found Optional

Scenario not found.

500 Internal Server Error Optional

Unexpected server error.

GET /
Authentication
REQUEST 
 
 
  
 
 RESPONSE