Skip to main content
GET
/
simulate
/
scenarios
/
List scenarios
curl --request GET \
  --url https://api.futureagi.com/simulate/scenarios/ \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Secret-Key: <api-key>'
{
  "count": 123,
  "next": "<string>",
  "previous": "<string>",
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "description": "<string>",
      "source": "<string>",
      "scenario_type": "DATASET",
      "organization": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dataset": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dataset_rows": 123,
      "status": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

X-Api-Key
string
header
required

API Key for authentication. Click here to access API Key

X-Secret-Key
string
header
required

Secret Key for authentication. Click here to access Secret Key

Query Parameters

Search by scenario name or source

agent_definition_id
string<uuid>

Filter by agent definition ID

page
integer
default:1
limit
integer
default:10

Response

200 - application/json

Paginated list of scenarios

count
integer
next
string | null
previous
string | null
results
object[]