Synthflow Simulation Scenarios API
The Simulation Scenarios API from Synthflow — 2 operation(s) for simulation scenarios.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/synthflow:synthflow-simulation-scenarios-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: PLATFORM Simulation Scenarios API
version: 1.0.0
servers:
- url: https://api.synthflow.ai/v2
description: Global
- url: https://api.us.synthflow.ai/v2
description: United States
- url: https://api.eu.synthflow.ai/v2
description: European Union
tags:
- name: Simulation Scenarios
paths:
/simulation_scenarios:
post:
operationId: create-simulation-scenario
summary: Create a simulation scenario
description: Create a new simulation scenario. Scenarios are templates used when generating test cases to ensure coverage of specific situations.
tags:
- Simulation Scenarios
parameters:
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
responses:
'200':
description: '200'
content:
application/json:
schema:
$ref: '#/components/schemas/create-simulation-scenario_Response_200'
'400':
description: '400'
content:
application/json:
schema:
$ref: '#/components/schemas/Create-simulation-scenarioRequestBadRequestError'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SimulationScenarioCreateIn'
get:
operationId: list-simulation-scenarios
summary: List simulation scenarios
description: List simulation scenarios with pagination and optional filtering.
tags:
- Simulation Scenarios
parameters:
- name: page_number
in: query
description: Page number.
required: false
schema:
type: integer
default: 1
- name: page_size
in: query
description: Number of items per page.
required: false
schema:
type: integer
default: 10
- name: search
in: query
description: Search term for simulation scenario names.
required: false
schema:
type: string
- name: start_date
in: query
description: Filter by created_at >= start_date (ISO format).
required: false
schema:
type: string
format: date-time
- name: end_date
in: query
description: Filter by created_at <= end_date (ISO format).
required: false
schema:
type: string
format: date-time
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
responses:
'200':
description: '200'
content:
application/json:
schema:
$ref: '#/components/schemas/list-simulation-scenarios_Response_200'
'400':
description: '400'
content:
application/json:
schema:
$ref: '#/components/schemas/List-simulation-scenariosRequestBadRequestError'
/simulation_scenarios/{scenario_id}:
get:
operationId: get-simulation-scenario
summary: Get a simulation scenario
description: Retrieve a simulation scenario by ID.
tags:
- Simulation Scenarios
parameters:
- name: scenario_id
in: path
description: Simulation scenario ID.
required: true
schema:
type: string
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
responses:
'200':
description: '200'
content:
application/json:
schema:
$ref: '#/components/schemas/get-simulation-scenario_Response_200'
'400':
description: '400'
content:
application/json:
schema:
$ref: '#/components/schemas/Get-simulation-scenarioRequestBadRequestError'
'404':
description: '404'
content:
application/json:
schema:
$ref: '#/components/schemas/Get-simulation-scenarioRequestNotFoundError'
put:
operationId: update-simulation-scenario
summary: Update a simulation scenario
description: Update an existing simulation scenario.
tags:
- Simulation Scenarios
parameters:
- name: scenario_id
in: path
description: Simulation scenario ID.
required: true
schema:
type: string
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
responses:
'200':
description: '200'
content:
application/json:
schema:
$ref: '#/components/schemas/update-simulation-scenario_Response_200'
'400':
description: '400'
content:
application/json:
schema:
$ref: '#/components/schemas/Update-simulation-scenarioRequestBadRequestError'
'404':
description: '404'
content:
application/json:
schema:
$ref: '#/components/schemas/Update-simulation-scenarioRequestNotFoundError'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SimulationScenarioUpdateIn'
delete:
operationId: delete-simulation-scenario
summary: Delete a simulation scenario
description: Delete a simulation scenario by ID.
tags:
- Simulation Scenarios
parameters:
- name: scenario_id
in: path
description: Simulation scenario ID.
required: true
schema:
type: string
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
responses:
'204':
description: '204'
content:
application/json:
schema:
type: object
properties: {}
'400':
description: '400'
content:
application/json:
schema:
$ref: '#/components/schemas/Delete-simulation-scenarioRequestBadRequestError'
'404':
description: '404'
content:
application/json:
schema:
$ref: '#/components/schemas/Delete-simulation-scenarioRequestNotFoundError'
components:
schemas:
Delete-simulation-scenarioRequestBadRequestError:
type: object
properties: {}
title: Delete-simulation-scenarioRequestBadRequestError
Get-simulation-scenarioRequestNotFoundError:
type: object
properties: {}
title: Get-simulation-scenarioRequestNotFoundError
Update-simulation-scenarioRequestNotFoundError:
type: object
properties: {}
title: Update-simulation-scenarioRequestNotFoundError
create-simulation-scenario_Response_200:
type: object
properties:
status:
$ref: '#/components/schemas/status'
response:
$ref: '#/components/schemas/SimulationScenarioReadOut'
title: create-simulation-scenario_Response_200
List-simulation-scenariosRequestBadRequestError:
type: object
properties: {}
title: List-simulation-scenariosRequestBadRequestError
list-simulation-scenarios_Response_200:
type: object
properties:
status:
$ref: '#/components/schemas/status'
response:
$ref: '#/components/schemas/PaginatedSimulationScenariosList'
title: list-simulation-scenarios_Response_200
update-simulation-scenario_Response_200:
type: object
properties:
status:
$ref: '#/components/schemas/status'
response:
$ref: '#/components/schemas/SimulationScenarioReadOut'
title: update-simulation-scenario_Response_200
Create-simulation-scenarioRequestBadRequestError:
type: object
properties: {}
title: Create-simulation-scenarioRequestBadRequestError
SimulationScenarioCreateIn:
type: object
properties:
name:
type: string
description: Name of the simulation scenario template
description:
type: string
description: Description of what the scenario template should verify when generating test cases
required:
- name
- description
title: SimulationScenarioCreateIn
status:
type: string
description: Whether the request was successful.
title: status
SimulationScenarioReadOut:
type: object
properties:
id:
type: string
format: uuid
description: Unique identifier for the simulation scenario
name:
type: string
description: Name of the simulation scenario template
description:
type: string
description: Description of what the scenario template should verify when generating test cases
workspace_id:
type: string
description: Workspace ID this simulation scenario belongs to
created_at:
type: string
format: date-time
description: When the simulation scenario was created
updated_at:
type: string
format: date-time
description: When the simulation scenario was last updated
title: SimulationScenarioReadOut
Delete-simulation-scenarioRequestNotFoundError:
type: object
properties: {}
title: Delete-simulation-scenarioRequestNotFoundError
get-simulation-scenario_Response_200:
type: object
properties:
status:
$ref: '#/components/schemas/status'
response:
$ref: '#/components/schemas/SimulationScenarioReadOut'
title: get-simulation-scenario_Response_200
SimulationScenarioUpdateIn:
type: object
properties:
name:
type:
- string
- 'null'
description: Name of the simulation scenario
description:
type:
- string
- 'null'
description: Description of the simulation scenario
title: SimulationScenarioUpdateIn
Update-simulation-scenarioRequestBadRequestError:
type: object
properties: {}
title: Update-simulation-scenarioRequestBadRequestError
Get-simulation-scenarioRequestBadRequestError:
type: object
properties: {}
title: Get-simulation-scenarioRequestBadRequestError
PaginatedSimulationScenariosList:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/SimulationScenarioReadOut'
description: List of simulation scenarios
total:
type: integer
description: Total number of simulation scenarios
page_number:
type: integer
description: Current page number
page_size:
type: integer
description: Number of items per page
required:
- items
- total
- page_number
- page_size
title: PaginatedSimulationScenariosList
securitySchemes:
sec0:
type: http
scheme: bearer