Scenarios

Get scenario detail

Returns full detail of a specific scenario including graph data and prompts.

get/simulate/scenarios/{scenario_id}/

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/simulate/scenarios/{scenario_id}/
  • Auth: one of:
    • API key in header X-Api-Key
    • API key in header X-Secret-Key

Response

OK

idstring uuid
namestring
descriptionstring nullable
sourcestring
scenario_type'graph' | 'script' | 'dataset'
dataset_idstring uuid nullable
organizationstring uuid
datasetstring uuid nullable
created_atstring date-time
updated_atstring date-time
deletedboolean
deleted_atstring date-time nullable
status'NotStarted' | 'Queued' | 'Running' | 'Completed' | 'Editing' | 'Inactive' | 'Failed' | 'PartialRun' | 'ExperimentEvaluation' | 'Uploading' | 'PartialExtracted' | 'Processing' | 'Deleting' | 'PartialCompleted' | 'OptimizationEvaluation' | 'Error' | 'Cancelled'
agent_typestring nullable
graphobject
dataset_rowsinteger
dataset_column_configobject nullable

Changes

No recorded changes to this operation across all 1 revision of this API.