Synthflow Simulations API
The Simulations API from Synthflow — 4 operation(s) for simulations.
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-simulations-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 Simulations 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: Simulations
paths:
/simulations:
post:
operationId: start-simulation
summary: Start a simulation
description: Start a new simulation using a simulation case.
tags:
- Simulations
parameters:
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
responses:
'200':
description: '200'
content:
application/json:
schema:
$ref: '#/components/schemas/start-simulation_Response_200'
'400':
description: '400'
content:
application/json:
schema:
$ref: '#/components/schemas/Start-simulationRequestBadRequestError'
'404':
description: '404'
content:
application/json:
schema:
$ref: '#/components/schemas/Start-simulationRequestNotFoundError'
'422':
description: '422'
content:
application/json:
schema:
$ref: '#/components/schemas/Start-simulationRequestUnprocessableEntityError'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SimulationCreateIn'
get:
operationId: list-simulations
summary: List simulations
description: List simulations with pagination and optional filters.
tags:
- Simulations
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: simulation_session_id
in: query
description: Filter by simulation session ID.
required: false
schema:
type: string
format: uuid
- name: status
in: query
description: Filter by simulation status.
required: false
schema:
$ref: '#/components/schemas/SimulationsGetParametersStatus'
- name: start_date
in: query
description: Filter by simulation created_at >= start_date (ISO 8601).
required: false
schema:
type: string
format: date-time
- name: end_date
in: query
description: Filter by simulation created_at <= end_date (ISO 8601).
required: false
schema:
type: string
format: date-time
- name: target_agent_id
in: query
description: Filter by target agent ID.
required: false
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/list-simulations_Response_200'
'422':
description: '422'
content:
application/json:
schema:
$ref: '#/components/schemas/List-simulationsRequestUnprocessableEntityError'
/simulations/sessions:
get:
operationId: list-simulation-sessions
summary: List simulation sessions
description: List simulation sessions with pagination and optional filters.
tags:
- Simulations
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: target_agent_id
in: query
description: Filter by target agent ID.
required: false
schema:
type: string
- name: start_date
in: query
description: Filter by simulation created_at >= start_date (ISO 8601).
required: false
schema:
type: string
format: date-time
- name: end_date
in: query
description: Filter by simulation created_at <= end_date (ISO 8601).
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-sessions_Response_200'
'400':
description: '400'
content:
application/json:
schema:
$ref: '#/components/schemas/List-simulation-sessionsRequestBadRequestError'
/simulations/session/{simulation_session_id}:
get:
operationId: get-simulation-session
summary: Get a simulation session
description: Retrieve simulation session details by ID.
tags:
- Simulations
parameters:
- name: simulation_session_id
in: path
description: Simulation session ID.
required: true
schema:
type: string
format: uuid
- 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-session_Response_200'
'404':
description: '404'
content:
application/json:
schema:
$ref: '#/components/schemas/Get-simulation-sessionRequestNotFoundError'
'422':
description: '422'
content:
application/json:
schema:
$ref: '#/components/schemas/Get-simulation-sessionRequestUnprocessableEntityError'
/simulations/{simulation_id}:
get:
operationId: get-simulation
summary: Get a simulation
description: Retrieve a simulation by ID.
tags:
- Simulations
parameters:
- name: simulation_id
in: path
description: Simulation ID.
required: true
schema:
type: string
format: uuid
- 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_Response_200'
'400':
description: '400'
content:
application/json:
schema:
$ref: '#/components/schemas/Get-simulationRequestBadRequestError'
'404':
description: '404'
content:
application/json:
schema:
$ref: '#/components/schemas/Get-simulationRequestNotFoundError'
'422':
description: '422'
content:
application/json:
schema:
$ref: '#/components/schemas/Get-simulationRequestUnprocessableEntityError'
components:
schemas:
SimulationSuccessCriteriaAnalysis:
type: object
properties:
success:
type: boolean
evaluations:
type: array
items:
$ref: '#/components/schemas/SimulationSuccessCriteriaEvaluation'
required:
- success
- evaluations
description: Summary of the success criteria evaluation results.
title: SimulationSuccessCriteriaAnalysis
Start-simulationRequestUnprocessableEntityError:
type: object
properties: {}
title: Start-simulationRequestUnprocessableEntityError
SimulationsSessionsGetResponsesContentApplicationJsonSchemaResponse:
type: object
properties:
pagination:
$ref: '#/components/schemas/pagination'
items:
type: array
items:
$ref: '#/components/schemas/SimulationSessionReadOut'
title: SimulationsSessionsGetResponsesContentApplicationJsonSchemaResponse
get-simulation-session_Response_200:
type: object
properties:
status:
$ref: '#/components/schemas/status'
response:
$ref: '#/components/schemas/SimulationSessionReadOut'
title: get-simulation-session_Response_200
SimulationReadOutStatus:
type: string
enum:
- in-progress
- completed
- failed
title: SimulationReadOutStatus
Get-simulationRequestNotFoundError:
type: object
properties: {}
title: Get-simulationRequestNotFoundError
Get-simulationRequestBadRequestError:
type: object
properties: {}
title: Get-simulationRequestBadRequestError
SimulationReadOut:
type: object
properties:
simulation_id:
type: string
format: uuid
simulation_session_id:
type: string
format: uuid
simulation_case_id:
type: string
format: uuid
simulation_case_name:
type:
- string
- 'null'
simulation_case_prompt:
type:
- string
- 'null'
success_criteria:
type:
- array
- 'null'
items:
type: string
call_success_type:
oneOf:
- $ref: '#/components/schemas/SimulationReadOutCallSuccessType'
- type: 'null'
persona_agent_id:
type:
- string
- 'null'
format: uuid
persona_phone_number:
type:
- string
- 'null'
target_agent_id:
type: string
format: uuid
agent_name:
type:
- string
- 'null'
agent_avatar_url:
type:
- string
- 'null'
target_phone_number:
type:
- string
- 'null'
target_call_id:
type:
- string
- 'null'
custom_variables:
type:
- object
- 'null'
additionalProperties:
description: Any type
status:
$ref: '#/components/schemas/SimulationReadOutStatus'
workspace_id:
type: string
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
error_info:
oneOf:
- $ref: '#/components/schemas/SimulationErrorInfo'
- type: 'null'
recording_url:
type:
- string
- 'null'
timeline:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/TimelineItem'
success_criteria_analysis:
oneOf:
- $ref: '#/components/schemas/SimulationSuccessCriteriaAnalysis'
- type: 'null'
description: Simulation details.
title: SimulationReadOut
SimulationsGetResponsesContentApplicationJsonSchemaResponse:
type: object
properties:
pagination:
$ref: '#/components/schemas/pagination'
items:
type: array
items:
$ref: '#/components/schemas/SimulationReadOut'
title: SimulationsGetResponsesContentApplicationJsonSchemaResponse
TimelineItem:
type: object
properties:
sender_type:
type:
- string
- 'null'
value:
type:
- string
- 'null'
type:
type:
- string
- 'null'
timestamp_datetime:
type:
- string
- 'null'
format: date-time
timestamp:
type:
- string
- 'null'
title: float
description: Timeline event for a simulation call.
title: TimelineItem
SimulationSessionReadOut:
type: object
properties:
simulation_session_id:
type: string
format: uuid
simulations:
type: array
items:
$ref: '#/components/schemas/SimulationReadOut'
total_simulations:
type: integer
completed_simulations:
type: integer
failed_simulations:
type: integer
pending_simulations:
type: integer
description: Simulation session summary.
title: SimulationSessionReadOut
list-simulations_Response_200:
type: object
properties:
status:
$ref: '#/components/schemas/status'
response:
$ref: '#/components/schemas/SimulationsGetResponsesContentApplicationJsonSchemaResponse'
title: list-simulations_Response_200
List-simulationsRequestUnprocessableEntityError:
type: object
properties: {}
title: List-simulationsRequestUnprocessableEntityError
SimulationErrorInfo:
type: object
properties:
message:
type: string
code:
type: integer
type:
type: string
required:
- message
- code
- type
description: Error information for failed simulations.
title: SimulationErrorInfo
start-simulation_Response_200:
type: object
properties:
status:
$ref: '#/components/schemas/status'
response:
$ref: '#/components/schemas/SimulationReadOut'
title: start-simulation_Response_200
SimulationReadOutCallSuccessType:
type: string
enum:
- all
- any
title: SimulationReadOutCallSuccessType
pagination:
type: object
properties:
total_records:
type: integer
limit:
type: integer
offset:
type: integer
title: pagination
Get-simulation-sessionRequestUnprocessableEntityError:
type: object
properties: {}
title: Get-simulation-sessionRequestUnprocessableEntityError
Start-simulationRequestBadRequestError:
type: object
properties: {}
title: Start-simulationRequestBadRequestError
get-simulation_Response_200:
type: object
properties:
status:
$ref: '#/components/schemas/status'
response:
$ref: '#/components/schemas/SimulationReadOut'
title: get-simulation_Response_200
SimulationCreateIn:
type: object
properties:
simulation_case_id:
type: string
format: uuid
simulation_session_id:
type:
- string
- 'null'
format: uuid
target_agent_id:
type: string
format: uuid
custom_variables:
type: object
additionalProperties:
description: Any type
required:
- simulation_case_id
- target_agent_id
description: Input payload to start a simulation.
title: SimulationCreateIn
Get-simulation-sessionRequestNotFoundError:
type: object
properties: {}
title: Get-simulation-sessionRequestNotFoundError
SimulationsGetParametersStatus:
type: string
enum:
- in-progress
- completed
- failed
title: SimulationsGetParametersStatus
SimulationSuccessCriteriaEvaluation:
type: object
properties:
success:
type: boolean
reasoning:
type: string
required:
- success
- reasoning
description: Evaluation result for a single success criterion.
title: SimulationSuccessCriteriaEvaluation
status:
type: string
description: Whether the request was successful.
title: status
list-simulation-sessions_Response_200:
type: object
properties:
status:
$ref: '#/components/schemas/status'
response:
$ref: '#/components/schemas/SimulationsSessionsGetResponsesContentApplicationJsonSchemaResponse'
title: list-simulation-sessions_Response_200
List-simulation-sessionsRequestBadRequestError:
type: object
properties: {}
title: List-simulation-sessionsRequestBadRequestError
Get-simulationRequestUnprocessableEntityError:
type: object
properties: {}
title: Get-simulationRequestUnprocessableEntityError
Start-simulationRequestNotFoundError:
type: object
properties: {}
title: Start-simulationRequestNotFoundError
securitySchemes:
sec0:
type: http
scheme: bearer