Synthflow Default API
The Default API from Synthflow — 49 operation(s) for default.
Synthflow Default API is one of 8 APIs that Synthflow publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 78 operations across 51 paths, and defines 465 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against 3 base URLs: https://api.synthflow.ai/v2, https://api.us.synthflow.ai/v2, https://api.eu.synthflow.ai/v2.
78 operations
51 paths
465 schemas
13 DELETE31 GET1 PATCH24 POST9 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Synthflow Default API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (sec0).
Paths & Operations 78
Across 51 paths, the API surfaces 78 operations — 13 DELETE, 31 GET, 1 PATCH, 24 POST, 9 PUT. Each is listed below with its method, path, parameters, and response codes.
Operations 78
POST
/assistants
Create an agent
PUT
/assistants/{model_id}
Update an agent
DELETE
/assistants/{model_id}
Delete an agent
GET
/assistants/{model_id}
Get an agent
GET
/assistants/
List agents
PUT
/assistants/{model_id}/phone_numbers
Attach phone numbers to an outbound agent
DELETE
/assistants/{model_id}/phone_numbers/{phone_number_slug}
Detach phone number from an outbound agent
POST
/calls
Make a call
GET
/calls
List calls
POST
/calls/outbound-test-ws-media
Start a WebSocket media call
GET
/calls/outbound-test-ws-media/base-url
Get the WebSocket media base URL
GET
/calls/{call_id}
Get a call
POST
/simulation_cases
Create a simulation case
GET
/simulation_cases
List simulation cases
GET
/simulation_cases/{simulation_case_id}
Get a simulation case
PUT
/simulation_cases/{simulation_case_id}
Update a simulation case
DELETE
/simulation_cases/{simulation_case_id}
Delete a simulation case
POST
/simulation_cases/generate
Generate test cases
GET
/simulation_cases/by_agent
List simulation cases by agent
POST
/simulation_suites
Create a simulation suite
GET
/simulation_suites
List simulation suites
GET
/simulation_suites/{suite_id}
Get a simulation suite
PUT
/simulation_suites/{suite_id}
Update a simulation suite
DELETE
/simulation_suites/{suite_id}
Delete a simulation suite
POST
/simulation_suites/{suite_id}/execute
Execute a simulation suite
POST
/simulation_scenarios
Create a simulation scenario
GET
/simulation_scenarios
List simulation scenarios
GET
/simulation_scenarios/{scenario_id}
Get a simulation scenario
PUT
/simulation_scenarios/{scenario_id}
Update a simulation scenario
DELETE
/simulation_scenarios/{scenario_id}
Delete a simulation scenario
POST
/simulations
Start a simulation
GET
/simulations
List simulations
GET
/simulations/sessions
List simulation sessions
GET
/simulations/session/{simulation_session_id}
Get a simulation session
GET
/simulations/{simulation_id}
Get a simulation
GET
/actions
List actions
POST
/actions
Create an action
POST
/actions/initialize
Initialize a custom action
PUT
/actions/{action_id}
Update an action
DELETE
/actions/{action_id}
Delete an action
GET
/actions/{action_id}
Get an action
POST
/actions/attach
Attach an action
POST
/actions/detach
Detach an action
GET
/analytics/
Export analytics data
GET
/voices
Get voices
GET
/knowledge_base
List knowledge bases
POST
/knowledge_base
Create a knowledge base
GET
/knowledge_base/{id}
Get a knowledge base
PUT
/knowledge_base/{id}
Update a knowledge base
DELETE
/knowledge_base/{id}
Delete a knowledge base
POST
/knowledge_base/{knowledge_base_id}/attach
Attach a knowledge base
POST
/knowledge_base/{knowledge_base_id}/detach
Detach a knowledge base
GET
/knowledge_base/{knowledge_base_id}/sources
List knowledge base sources
POST
/knowledge_base/{knowledge_base_id}/sources
Add a knowledge base source
PUT
/knowledge_base/{knowledge_base_id}/sources/{source_id}
Update a knowledge base source
DELETE
/knowledge_base/{knowledge_base_id}/sources/{source_id}
Delete a knowledge base source
POST
/phonebooks
Create a phone book
GET
/phonebooks
List phone books
DELETE
/phonebooks/{phone_book_id}
Delete a phone book
POST
/phonebooks/{phone_book_id}/entries
Create a phone book entry
DELETE
/phonebooks/{phone_book_id}/entries/{entry_id}
Delete a phone book entry
POST
/subaccounts
Create a subaccount
PUT
/subaccounts/{subaccount_id}
Update a subaccount
DELETE
/subaccounts/{subaccount_id}
Delete a subaccount
GET
/subaccounts/{subaccount_id}
Get a subaccount
GET
/subaccounts/
List subaccounts
GET
/contacts
List contacts
GET
/contacts/{contact_id}
Get a contact
DELETE
/contacts/{contact_id}
Delete a contact
GET
/memory_stores
List memory stores
PATCH
/memory_stores/{memory_store_id}
Update a memory store
DELETE
/memory_stores/{memory_store_id}
Delete a memory store
GET
/memory_stores/{memory_store_id}
Get a memory store
POST
/memory_stores/{memory_store_id}/assistants/{assistant_id}/attach
Attach a memory store to an agent
POST
/memory_stores/{memory_store_id}/assistants/{assistant_id}/detach
Detach a memory store from an agent
GET
/memory_stores/{memory_store_id}/contacts/{contact_id}/memory_data
Get data for a specific memory store and contact
POST
/memory_stores/{memory_store_id}/contacts/{contact_id}/attach
Attach a contact to a memory store
POST
/memory_stores/{memory_store_id}/contacts/{contact_id}/detach
Detach a contact from a memory store
Schemas 465
The contract defines 465 schemas that model the data the API accepts and returns. The most detailed are AssistantsPostRequestBodyContentApplicationJsonSchemaAgent (44 properties), Agent (42 properties), CallsGetResponsesContentApplicationJsonSchemaResponseCallsItems (30 properties), CallsCallIdGetResponsesContentApplicationJsonSchemaResponseCallsItems (25 properties). Each schema is shown below with its type and property counts.
VoicesGetParametersProvider
string
AssistantsGetResponsesContentApplicationJsonSchemaResponseAssistantsVoicemailMessageMode
string
The mode used to generate the voicemail message.
ContactsContactIdGetResponsesContentApplicationJsonSchemaResponse
object
9 properties
CallsGetResponsesContentApplicationJsonSchemaResponseCallsItems
object
30 properties
List-assistantRequestBadRequestError
object
KnowledgeBaseIdGetResponsesContentApplicationJsonSchemaResponseKnowledgeBasesItems
object
3 properties
ActionsPostRequestBodyContentApplicationJsonSchemaSendSms
object
2 properties
2 required
SimulationCaseReadOut
object
Simulation case details.
11 properties
UpdateKnowledgeBaseSourceRequest1
object
2 properties
1 required
SimulationCasesPostResponsesContentApplicationJsonSchemaResponse
object
1 property
List-simulationsRequestUnprocessableEntityError
object
AssistantsGetResponsesContentApplicationJsonSchemaResponseAssistants
object
11 properties
memory_store_id
string
The ID of the memory store (group).
voice_id
string
Voice ID for this agent. To retrieve voice IDs, use the Get voices endpoint.
AssistantsPostRequestBodyContentApplicationJsonSchemaAgentPatienceLevel
string
Patience level of the agent.
SimulationSuccessCriteriaEvaluation
object
Evaluation result for a single success criterion.
2 properties
2 required
SimulationsGetResponsesContentApplicationJsonSchemaResponse
object
2 properties
detachAContactFromAMemoryStore_Response_200
object
1 property
status
string
Whether the request was successful.
SimulationCaseReadOutType
string
Start-ws-media-callRequestUnauthorizedError
object
SubaccountsSubaccountIdPutRequestBodyContentApplicationJsonSchemaPricingTiersDetachItems
object
1 property
1 required
AssistantsPostResponsesContentApplicationJsonSchemaDetail
object
4 properties
4 required
ActionsActionIdDeleteResponsesContentApplicationJsonSchemaResponse
object
1 property
language
string
This agent's language. For the list of available languages, see Supported languages
attachAContactToAMemoryStore_Response_200
object
1 property
ActionsPostRequestBodyContentApplicationJsonSchemaRealTimeBookingGhlAutoconfirm
string
If confirmed is selected the meeting will be automatically accepted and you don't have to do anything, otherwise you have to go to GHL calendar and confirm the…
Start-simulationRequestBadRequestError
object
Voice-callRequestBadRequestError
object
get-simulation_Response_200
object
2 properties
List-simulation-scenariosRequestBadRequestError
object
VoicesGetResponsesContentApplicationJsonSchemaResponseVoicesItemsProvider
string
Voice provider (elevenlabs, deepgram, or synthflow).
Get-phone-callRequestNotFoundError
object
1 property
AssistantsPostRequestBodyContentApplicationJsonSchemaAgent
object
44 properties
List-simulation-sessionsRequestBadRequestError
object
ActionsAttachPostRequestBodyContentApplicationJsonSchemaItemsItems
object
5 properties
ActionsActionIdPutRequestBodyContentApplicationJsonSchemaInformationExtractor
object
4 properties
AssistantsPostRequestBodyContentApplicationJsonSchemaVoicemailMessageMode
string
The mode used to generate the voicemail message.
List-callsRequestBadRequestError
object
update-simulation-suite_Response_200
object
2 properties
AgentPatienceLevel
string
Patience level of the agent.
create-simulation-case_Response_200
object
2 properties
Create-simulation-scenarioRequestBadRequestError
object
Attach-phone-numbers-to-assistantRequestNotFoundError
object
1 property
ActionsActionIdPutRequestBodyContentApplicationJsonSchemaCustomActionIntegration
string
The possible integrations that can be selected to retrieve information
ActionsActionIdPutRequestBodyContentApplicationJsonSchemaSendSms
object
2 properties
AnalyticsGetResponsesContentApplicationJsonSchemaCallStatusStatItemsItems
object
4 properties
Attach-actionRequestBadRequestError
object
SubaccountsSubaccountIdPutResponsesContentApplicationJsonSchemaResponse
object
4 properties
voice_similarity_boost
integer
Range 0 to 1. Determines how closely the AI matches the original voice. Higher settings potentially including unwanted noise from the original recording.
SimulationCaseUpdateInCallSuccessType
string
Delete-simulation-suiteRequestNotFoundError
object
KnowledgeBaseKnowledgeBaseIdAttachPostResponsesContentApplicationJsonSchemaResponse
object
3 properties
SimulationSuccessCriteriaAnalysis
object
Summary of the success criteria evaluation results.
2 properties
2 required
ActionsActionIdPutRequestBodyContentApplicationJsonSchemaRealTimeBooking
object
7 properties
Update-simulation-suiteRequestBadRequestError
object
AssistantsPostRequestBodyContentApplicationJsonSchemaAgentMinWordsToInterrupt
string
You can set how many words the human must speak before the AI will stop speaking and listening.
AnalyticsGetResponsesContentApplicationJsonSchemaRecentCallHistoryItemsItems
object
7 properties
ActionsPostRequestBodyContentApplicationJsonSchemaCustomActionVariablesBeforeTheCallItems
object
2 properties
2 required
ActionsActionIdPutRequestBodyContentApplicationJsonSchemaCustomActionActionSound
string
Optional background audio played while this custom action executes. Defaults to no background audio. Omit the field, use null, or use an empty string to disabl…
get-phone-call_Response_200
object
2 properties
create-subaccount_Response_200
object
2 properties
attach-knowledge-base_Response_200
object
2 properties
CallsPostResponsesContentApplicationJsonSchemaResponse
object
2 properties
AgentVoiceSynthesizer
string
The engine used to synthesize voice.
AnalyticsGetParametersTypeOfCall
string
AnalyticsGetResponsesContentApplicationJsonSchemaCallStatusStatSeriesItems
object
13 properties
get-simulation-suite_Response_200
object
2 properties
allowed_idle_time_seconds
integer
The agent will disconnect after this period.
Update-simulation-suiteRequestNotFoundError
object
SubaccountsSubaccountIdGetResponsesContentApplicationJsonSchemaResponseSubaccountsItems
object
9 properties
AssistantsModelIdGetResponsesContentApplicationJsonSchemaResponseAssistantsItemsMaxDuration
object
2 properties
update-subaccount_Response_200
object
2 properties
SubaccountsSubaccountIdPutRequestBodyContentApplicationJsonSchemaImportSubscription
object
This section is used when you want to import an existing Stripe subscription for the subaccount
2 properties
ActionsActionIdGetResponsesContentApplicationJsonSchemaResponseActionsItemsInputVariablesAssistantsItemsInputVariablesMappingItems
object
4 properties
HumanAvailabilityScheduleItemPublic
object
Availability for a single weekday. Exactly one interval is currently supported.
2 properties
2 required
list-memory-stores_Response_200
object
2 properties
Generate-simulation-casesRequestBadRequestError
object
AnalyticsGetResponsesContentApplicationJsonSchemaSentimentStatSeriesItems
object
3 properties
ActionsAttachPostRequestBodyContentApplicationJsonSchemaItemsItemsAttachmentType
string
When this action is available in the conversation. Optional and defaults to during when omitted or null.
ContactsContactIdGetResponsesContentApplicationJsonSchemaResponseContactMetadata
object
1 property
SimulationSuiteReadOut
object
9 properties
Delete-actionRequestBadRequestError
object
getDataForASpecificMemoryStoreAndContact_Response_200
object
2 properties
name
string
Agent name.
KnowledgeBaseIdPutResponsesContentApplicationJsonSchemaResponse
object
2 properties
SubaccountsGetResponsesContentApplicationJsonSchemaResponseSubaccountsItemsPricingTiersItems
object
1 property
ActionsPostRequestBodyContentApplicationJsonSchemaRealTimeBookingGhl
object
Important: You need to be connected to the GHL integration
3 properties
3 required
ActionsPostRequestBodyContentApplicationJsonSchemaCustomActionVariablesDuringTheCallItems
object
4 properties
ActionsInitializePostRequestBodyContentApplicationJsonSchemaVariablesItems
object
2 properties
2 required
Generate-simulation-casesRequestNotFoundError
object
create-assistant_Response_200
object
3 properties
ActionsActionIdPutRequestBodyContentApplicationJsonSchemaCustomActionQueryParametersItems
object
2 properties
2 required
ActionsPostRequestBodyContentApplicationJsonSchemaInformationExtractor
object
3 properties
Get-ws-media-base-urlRequestUnauthorizedError
object
AnalyticsGetResponsesContentApplicationJsonSchemaExecutedActions
object
List of actions executed during the call, as well as their success and frequency rates.
1 property
LiveTransferCreateDirectPhoneConfig
object
16 properties
4 required
get-ws-media-base-url_Response_200
object
1 property
1 required
Update-simulation-scenarioRequestBadRequestError
object
Get-phone-callRequestBadRequestError
object
1 property
ActionsActionIdGetResponsesContentApplicationJsonSchemaResponseActionsItemsParametersHardCoded
object
1 property
AssistantsModelIdPhoneNumbersPutResponsesContentApplicationJsonSchemaDetail
object
4 properties
4 required
ActionsPostRequestBodyContentApplicationJsonSchemaInformationExtractorSingleChoice
object
3 properties
1 required
CallsGetResponsesContentApplicationJsonSchemaResponsePagination
object
Pagination information for the response
3 properties
ActionsActionIdGetResponsesContentApplicationJsonSchemaResponseActionsItemsActionType
string
Action type.
SimulationCasesGetParametersSimulationCaseType
string
SubaccountsGetResponsesContentApplicationJsonSchemaResponseSubaccountsItems
object
9 properties
AnalyticsGetResponsesContentApplicationJsonSchemaEndCallReasonStatSeriesItems
object
10 properties
Update-assistantRequestBadRequestError
object
1 property
Delete-subaccountRequestBadRequestError
object
LiveTransferUpdatePhoneBookConfigTransferMode
string
Transfer mode.
VoicesGetResponsesContentApplicationJsonSchemaResponseVoicesItemsGender
string
Voice gender.
HumanAvailabilityIntervalPublic
object
One availability interval in 24-hour format.
2 properties
2 required
KnowledgeBaseGetResponsesContentApplicationJsonSchemaResponse
object
2 properties
listKnowledgeBaseSources_Response_200
object
2 properties
AssistantsModelIdPutRequestBodyContentApplicationJsonSchemaVoicemailMessage
object
Configuration for the message left when a voicemail is detected. Requires greetingmessagemode to be set to human.
4 properties
attach-phone-numbers-to-assistant_Response_200
object
1 property
AnalyticsGetResponsesContentApplicationJsonSchemaAssistantPerformanceByMinutesUsedItems
object
4 properties
SubaccountsSubaccountIdPutRequestBodyContentApplicationJsonSchemaRevokePermissionsItems
string
Get-simulationRequestNotFoundError
object
UpdateKnowledgeBaseSourceRequest0
object
2 properties
1 required
get-simulation-session_Response_200
object
2 properties
AssistantsPostRequestBodyContentApplicationJsonSchemaAgentVoiceSynthesizer
string
The engine used to synthesize voice.
Get-simulation-scenarioRequestBadRequestError
object
SimulationsSessionsGetResponsesContentApplicationJsonSchemaResponse
object
2 properties
get-subaccount_Response_200
object
2 properties
SimulationSuiteListItem
object
9 properties
4 required
ActionsActionIdGetResponsesContentApplicationJsonSchemaResponse
object
1 property
deleteAContact_Response_200
object
1 property
list-simulation-scenarios_Response_200
object
2 properties
SimulationScenarioUpdateIn
object
2 properties
greeting_message_mode
string
Controls how the agent delivers the initial greeting. human: the agent waits for the human to speak first. agentstatic: the agent speaks greetingmessage once t…
ActionsPostRequestBodyContentApplicationJsonSchemaRealTimeBooking
object
7 properties
5 required
AssistantsModelIdPutResponsesContentApplicationJsonSchemaDetail
object
4 properties
4 required
Update-simulation-scenarioRequestNotFoundError
object
Get-assistantRequestBadRequestError
object
AgentBackgroundNoiseType
string
What kind of background noise should be present.
ActionsPostRequestBodyContentApplicationJsonSchemaCustomActionHttpMode
string
Select the method that will be used
Initialize-actionRequestBadRequestError
object
Get-knowledge-baseRequestBadRequestError
object
list-simulation-suites_Response_200
object
2 properties
ActionsActionIdPutRequestBodyContentApplicationJsonSchemaRealTimeBookingGhl
object
2 properties
HumanAvailabilityPublic
object
Human availability schedule used by live transfer actions.
4 properties
3 required
AssistantsModelIdGetResponsesContentApplicationJsonSchemaResponseAssistantsItemsInputVariablesItemsValuesItems
object
5 properties
2 required
ActionsGetResponsesContentApplicationJsonSchemaResponsePagination
object
3 properties
model_id
string
Agent ID. You can find it on the agent’s page in your dashboard.
KnowledgeBaseKnowledgeBaseIdSourcesGetResponsesContentApplicationJsonSchemaResponseSourcesItemsType
string
Source type: text for plain text, web for a scraped web page, or pdf for a PDF file.
LiveTransferCreatePhoneBookConfigTransferMode
string
Transfer mode.
ActionsGetResponsesContentApplicationJsonSchemaResponseActionsItemsParametersHardCoded
object
1 property
updateAMemoryStore_Response_200
object
1 property
SimulationCaseSummary
object
2 properties
2 required
transcriber_provider
string
Speech-to-text provider used for transcription.
Update-simulation-caseRequestBadRequestError
object
Create-subaccountRequestBadRequestError
object
CallsCallIdGetResponsesContentApplicationJsonSchemaDetail
object
4 properties
4 required
Start-simulationRequestNotFoundError
object
AnalyticsGetResponsesContentApplicationJsonSchemaSentimentStat
object
Sentiment overview.
3 properties
greeting_message
string
The greeting message the agent will open the conversation with. You can add variables in curly brackets (for example, {your-variable} ).
update-knowledge-base-source_Response_200
object
2 properties
Create-knowledge-baseRequestBadRequestError
object
update-assistant_Response_200
object
3 properties
AssistantsModelIdPutRequestBodyContentApplicationJsonSchemaVoicemailMessageMode
string
The mode used to generate the voicemail message.
AnalyticsGetResponsesContentApplicationJsonSchemaCallStatusStat
object
Call status overview.
2 properties
Get-simulationRequestUnprocessableEntityError
object
ContactsGetResponsesContentApplicationJsonSchemaResponseItemsItemsContactMetadata
object
Update-simulation-caseRequestNotFoundError
object
voice_style
integer
Range 0 to 1. Enhances the distinct characteristics of the original voice, but may slow down processing and make the voice less stable.
SubaccountsSubaccountIdGetResponsesContentApplicationJsonSchemaResponseSubaccountsItemsSubscription
object
2 properties
AnalyticsGetResponsesContentApplicationJsonSchemaDurationMetrics
object
Duration metrics overview.
7 properties
list-subaccounts_Response_200
object
2 properties
PhonebooksPhoneBookIdEntriesPostResponsesContentApplicationJsonSchemaResponse
object
1 property
Get-ws-media-base-urlRequestServiceUnavailableError
object
Agent
object
42 properties
SimulationCaseGenerateInIncludeTestsItems
string
CallsGetResponsesContentApplicationJsonSchemaResponseCallsItemsTelephonyDisconnectReason
string
Get-simulation-scenarioRequestNotFoundError
object
ActionsActionIdGetResponsesContentApplicationJsonSchemaResponseActionsItemsInputVariablesAssistantsItemsInputVariablesMappingItemsSource
string
HumanAvailabilityScheduleItemPublicWeekday
string
Lowercase full weekday name.
ActionsPostRequestBodyContentApplicationJsonSchemaInformationExtractorYesNo
object
2 properties
1 required
SimulationSuiteCreateIn
object
3 properties
2 required
Generate-simulation-casesRequestUnprocessableEntityError
object
voice_prompt
string
Slightly alters the agent's intonation, talking speed or sentiment for a subtle yet noticeable effect.
MemoryStoresMemoryStoreIdContactsContactIdMemoryDataGetResponsesContentApplicationJsonSchemaResponse
object
5 properties
ActionsActionIdPutRequestBodyContentApplicationJsonSchemaCustomActionHttpMode
string
Select the method that will be used
Delete-simulation-caseRequestBadRequestError
object
SubaccountsSubaccountIdPutRequestBodyContentApplicationJsonSchemaGrantPermissionsItems
string
Get-simulation-caseRequestNotFoundError
object
KnowledgeBaseKnowledgeBaseIdSourcesPostResponsesContentApplicationJsonSchemaResponse
object
1 property
1 required
AssistantsPostRequestBodyContentApplicationJsonSchemaAgentNoiseCancellation
string
Removes background noise on the customer's side (like chatter in a café or keyboard clicks) to make their voice clearer and easier for the agent to understand.
Get-voicesRequestBadRequestError
object
ActionsActionIdPutRequestBodyContentApplicationJsonSchemaCustomActionCustomAuth
object
4 properties
CallsOutboundTestWsMediaPostRequestBodyContentApplicationJsonSchemaWsMediaCodec
string
Codec to use for the WebSocket media stream. l16 is raw big-endian 16-bit PCM at 16 kHz.
ActionsAttachPostRequestBodyContentApplicationJsonSchemaItemsItemsInputVariablesMappingItemsLlmConfig
object
3 properties
ActionsActionIdGetResponsesContentApplicationJsonSchemaResponseActionsItems
object
7 properties
ActionsActionIdPutRequestBodyContentApplicationJsonSchemaCustomActionVariablesBeforeTheCallItems
object
2 properties
2 required
AssistantsPostResponsesContentApplicationJsonSchemaDetails
object
2 properties
list-assistant_Response_200
object
2 properties
voice_stability
integer
Range is 0 to 1. Lower settings may make the voice sound more expressive but less predictable, while higher settings make it sound steadier but less emotional.
ActionsActionIdPutRequestBodyContentApplicationJsonSchemaCustomActionVariablesDuringTheCallItems
object
4 properties
KnowledgeBaseKnowledgeBaseIdSourcesPostRequestBodyContentApplicationJsonSchemaType
string
Source type.
Get-simulation-suiteRequestNotFoundError
object
CallsCallIdGetResponsesContentApplicationJsonSchemaResponseCallsItemsTelephonyDisconnectReason
string
The reason the telephony connection was disconnected.
ActionsGetResponsesContentApplicationJsonSchemaResponseActionsItems
object
5 properties
voice-call_Response_200
object
3 properties
AssistantsModelIdPutRequestBodyContentApplicationJsonSchemaMaxDuration
object
2 properties
AssistantsPostRequestBodyContentApplicationJsonSchemaAgentBackgroundNoise
object
Add background noise to make the call more natural.
3 properties
Detach-actionRequestBadRequestError
object
update-simulation-scenario_Response_200
object
2 properties
ActionsGetResponsesContentApplicationJsonSchemaResponse
object
2 properties
Update-simulation-caseRequestUnprocessableEntityError
object
ContactsGetResponsesContentApplicationJsonSchemaResponse
object
4 properties
Delete-simulation-suiteRequestBadRequestError
object
CallsCallIdGetResponsesContentApplicationJsonSchemaResponsePagination
object
Pagination information for the results.
3 properties
analyticsExport_Response_200
object
7 properties
ActionsPostResponsesContentApplicationJsonSchemaResponse
object
3 properties
SimulationCasesGetResponsesContentApplicationJsonSchemaResponse
object
2 properties
Get-simulation-suiteRequestBadRequestError
object
AssistantsPostRequestBodyContentApplicationJsonSchemaAgentBackgroundNoiseType
string
What kind of background noise should be present.
get-voices_Response_200
object
2 properties
ActionsAttachPostRequestBodyContentApplicationJsonSchemaItemsItemsInputVariablesMappingItemsSource
string
Source used to populate the variable.
ActionsActionIdGetResponsesContentApplicationJsonSchemaResponseActionsItemsInputVariablesValuesItemsExample
AgentMinWordsToInterrupt
string
You can set how many words the human must speak before the AI will stop speaking and listening.
SimulationScenarioCreateIn
object
2 properties
2 required
Get-simulation-caseRequestBadRequestError
object
AssistantsPostResponsesContentApplicationJsonSchemaResponse
object
1 property
Get-actionRequestBadRequestError
object
list-simulation-cases-by-agent_Response_200
object
2 properties
ActionsPostRequestBodyContentApplicationJsonSchemaCustomActionActionSound
string
Optional background audio played while this custom action executes. Defaults to no background audio. Omit the field, use null, or use an empty string to disabl…
greeting_message_human_talk_timeout
integer
The maximum number of seconds the agent waits for the human to speak first when greetingmessagemode is set to human. If the human does not speak within this ti…
Get-subaccountRequestBadRequestError
object
AnalyticsGetResponsesContentApplicationJsonSchemaRecentCallHistory
object
Log of all recent calls.
1 property
Create-actionRequestBadRequestError
object
AssistantsGetResponsesContentApplicationJsonSchemaResponse
object
2 properties
AnalyticsGetResponsesContentApplicationJsonSchemaAssistantPerformanceByCallsMadeItems
object
4 properties
knowledge_base_id
string
Knowledge base ID.
Execute-simulation-suiteRequestBadRequestError
object
KnowledgeBaseKnowledgeBaseIdSourcesGetResponsesContentApplicationJsonSchemaResponseSourcesItems
object
7 properties
SubaccountsPostResponsesContentApplicationJsonSchemaResponse
object
5 properties
AgentBackgroundNoise
object
Add background noise to make the call more natural.
3 properties
get-assistant_Response_200
object
2 properties
KnowledgeBaseKnowledgeBaseIdSourcesSourceIdDeleteResponsesContentApplicationJsonSchemaResponse
object
2 properties
LiveTransferUpdatePhoneBookConfig
object
17 properties
4 required
ActionsPostRequestBodyContentApplicationJsonSchemaCustomActionVariablesDuringTheCallItemsType
string
Type of the variable
SimulationErrorInfo
object
Error information for failed simulations.
3 properties
3 required
Get-simulation-sessionRequestUnprocessableEntityError
object
AttachPhoneNumbersToAssistantRequest0
object
1 property
1 required
AssistantsGetResponsesContentApplicationJsonSchemaResponseAssistantsVoicemailMessage
object
Configuration for the message left when a voicemail is detected. Requires greetingmessagemode to be set to human.
4 properties
llm
string
The LLM powering this agent.
LiveTransferCreatePhoneBookConfig
object
16 properties
4 required
ActionsActionIdPutRequestBodyContentApplicationJsonSchemaCustomActionVariablesDuringTheCallItemsType
string
Type of the variable
Delete-simulation-caseRequestNotFoundError
object
AssistantsModelIdGetResponsesContentApplicationJsonSchemaResponseAssistantsItemsInputVariablesItems
object
3 properties
2 required
create-simulation-suite_Response_200
object
2 properties
List-actionsRequestBadRequestError
object
ActionsPostRequestBodyContentApplicationJsonSchemaIncallSms
object
5 properties
1 required
ActionsActionIdGetResponsesContentApplicationJsonSchemaResponseActionsItemsInputVariablesValuesItems
object
4 properties
detach-knowledge-base_Response_200
object
2 properties
Delete-knowledge-baseRequestBadRequestError
object
createAPhoneBookEntry_Response_200
object
2 properties
AnalyticsGetResponsesContentApplicationJsonSchemaEndCallReasonStatItemsItems
object
3 properties
CallsGetResponsesContentApplicationJsonSchemaResponse
object
2 properties
Create-simulation-suiteRequestBadRequestError
object
CallsCallIdGetResponsesContentApplicationJsonSchemaResponse
object
2 properties
ActionsPostRequestBodyContentApplicationJsonSchemaRealTimeBookingTimezone
string
[List of possible time zones](/time-zones). The default is Europe/Berlin
AssistantsModelIdDeleteResponsesContentApplicationJsonSchemaResponse
object
1 property
AnalyticsGetResponsesContentApplicationJsonSchemaExecutedActionsItemsItems
object
4 properties
deleteAMemoryStore_Response_200
object
1 property
AssistantsPostRequestBodyContentApplicationJsonSchemaAgentEndCallReasonsV2Items
object
3 properties
1 required
CallsCallIdGetResponsesContentApplicationJsonSchemaResponseCallsItemsTelephonyHangup
string
Indicates which party ended the call.
ActionsPostRequestBodyContentApplicationJsonSchemaRealTimeBookingCalcomIntegration
string
The selected option will be the meeting type that will be created when the booking is done
LiveTransferCreateDirectPhoneConfigTransferMode
string
Transfer mode.
deleteAPhoneBook_Response_200
object
1 property
SimulationCaseReadOutBaseAgent
object
7 properties
ActionsPostRequestBodyContentApplicationJsonSchemaCustomActionHeadersItems
object
2 properties
2 required
SubaccountsSubaccountIdGetResponsesContentApplicationJsonSchemaResponseSubaccountsItemsPricingTiersItems
object
1 property
KnowledgeBaseIdDeleteResponsesContentApplicationJsonSchemaResponse
object
PaginatedSimulationScenariosList
object
4 properties
4 required
SimulationCreateIn
object
Input payload to start a simulation.
4 properties
2 required
AssistantsModelIdGetResponsesContentApplicationJsonSchemaResponseAssistantsItems
object
14 properties
SubaccountsSubaccountIdGetResponsesContentApplicationJsonSchemaResponseSubaccountsItemsMembersItems
object
2 properties
Get-simulationRequestBadRequestError
object
voice_use_speaker_boost
boolean
Amplifies the voice’s likeness to the original speaker, which can slightly slow down the response time.
UpdateKnowledgeBaseSourceRequest2
object
2 properties
1 required
voice_optimise_streaming_latency
integer
Range 0 to 4. Optimises streaming latency
AgentEndCallReasonsV2ItemsClosingMessageMode
string
Controls how the farewell message is generated. static: message is spoken verbatim. prompt: message is an instruction to the LLM. none: LLM generates its own f…
SimulationsGetParametersStatus
string
Detach-phone-number-from-assistantRequestBadRequestError
object
1 property
SubaccountsSubaccountIdDeleteResponsesContentApplicationJsonSchemaResponse
object
1 property
update-action_Response_200
object
2 properties
list-simulation-cases_Response_200
object
2 properties
PhonebooksPostResponsesContentApplicationJsonSchemaResponse
object
1 property
AssistantsPostRequestBodyContentApplicationJsonSchemaAgentFallbackProvider
string
The provider for the fallback voice (elevenlabs, deepgram, or synthflow).
SimulationReadOutStatus
string
AssistantsModelIdPutResponsesContentApplicationJsonSchemaResponse
object
1 property
Update-knowledge-baseRequestBadRequestError
object
SimulationCaseUpdateIn
object
Fields that can be updated for a simulation case.
5 properties
CallsCallIdGetResponsesContentApplicationJsonSchemaResponseCallsItemsEndCallReason
string
The reason the call ended from the AI agent's perspective.
CallsGetResponsesContentApplicationJsonSchemaResponseCallsItemsTelephonyHangup
string
SimulationCaseGenerateIn
object
Input payload to generate simulation cases.
3 properties
2 required
attach-action_Response_200
object
2 properties
MemoryStoresMemoryStoreIdGetResponsesContentApplicationJsonSchemaResponse
object
6 properties
AnalyticsGetResponsesContentApplicationJsonSchemaAssistantPerformance
object
Agent performance overview.
3 properties
delete-subaccount_Response_200
object
2 properties
SubaccountsSubaccountIdPutRequestBodyContentApplicationJsonSchemaProducts
object
Objects to be imported to or returned from the subaccountid
1 property
delete-assistant_Response_200
object
2 properties
CallsGetResponsesContentApplicationJsonSchemaResponseCallsItemsExecutedActions
object
Actions executed during the call
SubaccountsGetResponsesContentApplicationJsonSchemaResponseSubaccountsItemsSubscription
object
2 properties
ActionsActionIdGetResponsesContentApplicationJsonSchemaResponseActionsItemsInputVariablesAssistantsItems
object
3 properties
ActionsActionIdGetResponsesContentApplicationJsonSchemaResponseActionsItemsInputVariables
object
Input variable details for this action, including variable definitions and attached assistant IDs.
2 properties
update-knowledge-base_Response_200
object
2 properties
Create-simulation-caseRequestBadRequestError
object
ActionsAttachPostRequestBodyContentApplicationJsonSchemaItemsItemsInputVariablesMappingItems
object
4 properties
2 required
PhonebooksGetResponsesContentApplicationJsonSchemaResponseItemsItems
object
5 properties
SimulationScenarioReadOut
object
6 properties
Start-simulationRequestUnprocessableEntityError
object
Execute-simulation-suiteRequestNotFoundError
object
ActionsActionIdPutRequestBodyContentApplicationJsonSchemaRealTimeBookingCalcom
object
4 properties
List-simulation-casesRequestBadRequestError
object
AssistantsPostRequestBodyContentApplicationJsonSchemaVoicemailMessage
object
Configuration for the message left when a voicemail is detected. Requires greetingmessagemode to be set to human.
4 properties
AgentFallbackProvider
string
The provider for the fallback voice (elevenlabs, deepgram, or synthflow).
detachAMemoryStoreFromAnAgent_Response_200
object
1 property
initialize-action_Response_200
object
2 properties
type
string
Agent type.
AssistantsModelIdGetResponsesContentApplicationJsonSchemaResponseAssistantsItemsVoicemailMessage
object
Configuration for the message left when a voicemail is detected. Requires greetingmessagemode to be set to human.
4 properties
Start-ws-media-callRequestServiceUnavailableError
object
CallsGetResponsesContentApplicationJsonSchemaResponseCallsItemsCollectedVariables
object
2 properties
ActionsPostRequestBodyContentApplicationJsonSchemaCustomActionQueryParametersItems
object
2 properties
2 required
ActionsActionIdPutRequestBodyContentApplicationJsonSchemaIncallWhatsapp
object
5 properties
ActionsPostRequestBodyContentApplicationJsonSchemaInformationExtractorOpenQuestion
object
3 properties
1 required
AssistantsGetResponsesContentApplicationJsonSchemaResponseAssistantsMaxDuration
object
2 properties
ActionsPostRequestBodyContentApplicationJsonSchemaCustomAction
object
21 properties
4 required
AssistantsPostRequestBodyContentApplicationJsonSchemaMaxDuration
object
2 properties
SubaccountsGetResponsesContentApplicationJsonSchemaResponse
object
1 property
ActionsPostRequestBodyContentApplicationJsonSchemaCustomEvalQuestionCategory
string
Custom evalution category.
ActionsActionIdGetResponsesContentApplicationJsonSchemaResponseActionsItemsInputVariablesAssistantsItemsInputVariablesMappingItemsLlmConfig
object
3 properties
listPhoneBooks_Response_200
object
2 properties
CallsCallIdGetResponsesContentApplicationJsonSchemaResponseCallsItemsExecutedActions
object
Actions that were executed during the call.
CallsCallIdGetResponsesContentApplicationJsonSchemaResponseCallsItemsTypeOfCall
string
Call type.
start-ws-media-call_Response_200
object
3 properties
2 required
List-simulation-cases-by-agentRequestBadRequestError
object
delete-knowledge-base_Response_200
object
2 properties
list-actions_Response_200
object
2 properties
TimelineItem
object
Timeline event for a simulation call.
5 properties
attach-phone-numbers-to-assistant_Request
SimulationSuiteUpdateIn
object
2 properties
createAPhoneBook_Response_200
object
2 properties
Delete-simulation-scenarioRequestNotFoundError
object
CallsCallIdGetResponsesContentApplicationJsonSchemaResponseCallsItemsPromptVariables
object
Prompt variables.
SubaccountsSubaccountIdPutRequestBodyContentApplicationJsonSchemaProductsPhoneNumbersItems
object
1 property
CallsCallIdGetResponsesContentApplicationJsonSchemaResponseCallsItemsCollectedVariables
object
2 properties
KnowledgeBasePostResponsesContentApplicationJsonSchemaResponse
object
2 properties
ContactsGetResponsesContentApplicationJsonSchemaResponseItemsItems
object
9 properties
update-knowledge-base-source_Request
AttachedPhoneNumber
object
3 properties
3 required
ActionsActionIdPutRequestBodyContentApplicationJsonSchemaCustomAction
object
21 properties
CallsOutboundTestWsMediaPostRequestBodyContentApplicationJsonSchemaWsMediaFraming
string
Wire format for the WebSocket media stream. rtp (default) sends full RTP packets; payload sends raw codec payloads (RTP header stripped), which is simpler for…
get-knowledge-base_Response_200
object
2 properties
create-knowledge-base_Response_200
object
2 properties
SubaccountsPostRequestBodyContentApplicationJsonSchemaRevokePermissionsItems
string
execute-simulation-suite_Response_200
object
5 properties
VoicesGetResponsesContentApplicationJsonSchemaResponseVoicesItems
object
7 properties
ActionsPostRequestBodyContentApplicationJsonSchemaCustomEvalQuestion
object
4 properties
KnowledgeBaseKnowledgeBaseIdSourcesSourceIdPutResponsesContentApplicationJsonSchemaResponse
object
1 property
Update-actionRequestBadRequestError
object
getAMemoryStore_Response_200
object
2 properties
ActionsPostRequestBodyContentApplicationJsonSchemaCustomActionCustomAuth
object
4 properties
getAContact_Response_200
object
2 properties
Update-subaccountRequestBadRequestError
object
ActionsAttachPostResponsesContentApplicationJsonSchemaResponse
object
transcriber_keywords
array
Add business terms to improve accuracy and recognition.
transcriber_speech_recognition
string
Speech recognition mode for transcription speed vs quality.
SubaccountsSubaccountIdPutRequestBodyContentApplicationJsonSchemaPricingTiersAttachItems
object
1 property
1 required
ActionsDetachPostResponsesContentApplicationJsonSchemaResponse
object
initial_pause_seconds
integer
Duration before the agent starts speaking.
subaccount_id
string
Subaccount ID.
SimulationSessionReadOut
object
Simulation session summary.
6 properties
get-action_Response_200
object
2 properties
get-simulation-case_Response_200
object
2 properties
ActionsPostRequestBodyContentApplicationJsonSchemaCustomActionIntegration
string
The possible integrations that can be selected to retrieve information
SimulationReadOut
object
Simulation details.
23 properties
AgentEndCallReasonsV2Items
object
3 properties
1 required
AssistantsModelIdGetResponsesContentApplicationJsonSchemaResponse
object
2 properties
AgentListItem
object
3 properties
ActionsPostRequestBodyContentApplicationJsonSchemaRealTimeBookingCalcom
object
Important: You need to be connected to the Cal.com integration
5 properties
2 required
prompt
string
Add variables in curly brackets. For example, {your-variable} .
SubaccountsPostRequestBodyContentApplicationJsonSchemaGrantPermissionsItems
string
Start-ws-media-callRequestBadRequestError
object
SimulationCaseReadOutCallSuccessType
string
call_id
string
Call ID. You can find it on the logs page in your dashboard.
PhonebooksGetResponsesContentApplicationJsonSchemaResponse
object
4 properties
AssistantsModelIdGetResponsesContentApplicationJsonSchemaResponseAssistantsItemsVoicemailMessageMode
string
The mode used to generate the voicemail message.
AssistantsModelIdPutResponsesContentApplicationJsonSchemaDetails
object
2 properties
SubaccountsGetResponsesContentApplicationJsonSchemaResponseSubaccountsItemsMembersItems
object
2 properties
attachDocumentToSource_Response_200
object
2 properties
2 required
list-simulations_Response_200
object
2 properties
SubaccountsGetResponsesContentApplicationJsonSchemaResponseSubaccountsItemsPermissions
object
13 properties
SimulationReadOutCallSuccessType
string
List-subaccountsRequestBadRequestError
object
SimulationCaseCreateIn
object
Input payload to create a simulation case.
7 properties
5 required
detach-action_Response_200
object
2 properties
CallsPostRequestBodyContentApplicationJsonSchemaCustomVariablesItems
object
2 properties
pagination
object
3 properties
ring_pause_seconds
integer
Ring time before the agent answers the call.
KnowledgeBaseKnowledgeBaseIdSourcesGetResponsesContentApplicationJsonSchemaResponse
object
3 properties
ActionsInitializePostResponsesContentApplicationJsonSchemaResponse
object
1 property
Get-simulation-sessionRequestNotFoundError
object
KnowledgeBaseKnowledgeBaseIdDetachPostResponsesContentApplicationJsonSchemaResponse
object
2 properties
detach-phone-number-from-assistant_Response_200
object
1 property
ActionsActionIdPutRequestBodyContentApplicationJsonSchemaLiveTransfer
list-calls_Response_200
object
2 properties
KnowledgeBaseIdGetResponsesContentApplicationJsonSchemaResponse
object
2 properties
attachAMemoryStoreToAnAgent_Response_200
object
1 property
ActionsActionIdPutRequestBodyContentApplicationJsonSchemaRealTimeBookingCalcomIntegration
string
The selected option will be the meeting type that will be created when the booking is done
MemoryStoresGetResponsesContentApplicationJsonSchemaResponse
object
4 properties
PaginatedSimulationSuitesList
object
4 properties
4 required
ActionsActionIdPutRequestBodyContentApplicationJsonSchemaCustomActionHeadersItems
object
2 properties
2 required
ActionsActionIdPutRequestBodyContentApplicationJsonSchemaRealTimeBookingTimezone
string
[List of possible time zones](/time-zones).
Detach-phone-number-from-assistantRequestNotFoundError
object
1 property
update-simulation-case_Response_200
object
2 properties
AttachPhoneNumbersToAssistantRequest1
object
1 property
1 required
ActionsActionIdPutRequestBodyContentApplicationJsonSchemaRealTimeBookingGhlAutoconfirm
string
If confirmed is selected the meeting will be automatically accepted and you don't have to do anything, otherwise you have to go to GHL calendar and confirm the…
ActionsActionIdPutResponsesContentApplicationJsonSchemaResponse
object
1 property
Delete-assistantRequestBadRequestError
object
AnalyticsGetResponsesContentApplicationJsonSchemaEndCallReasonStat
object
An overview of reasons calls ended. For details on all the possible reasons, see [End Call Reasons](/logsend-call-reasons).
2 properties
list-knowledge-bases_Response_200
object
2 properties
Delete-simulation-scenarioRequestBadRequestError
object
ActionsPostRequestBodyContentApplicationJsonSchemaIncallWhatsapp
object
5 properties
1 required
create-simulation-scenario_Response_200
object
2 properties
list-contacts_Response_200
object
2 properties
AnalyticsGetResponsesContentApplicationJsonSchemaAssistantPerformanceBySuccessRateItems
object
4 properties
AgentNoiseCancellation
string
Removes background noise on the customer's side (like chatter in a café or keyboard clicks) to make their voice clearer and easier for the agent to understand.
ActionsPostRequestBodyContentApplicationJsonSchemaLiveTransfer
AnalyticsGetResponsesContentApplicationJsonSchemaExecutedActionsItemsItemsSeriesItems
object
2 properties
MemoryStoresGetResponsesContentApplicationJsonSchemaResponseItemsItems
object
6 properties
start-simulation_Response_200
object
2 properties
list-simulation-sessions_Response_200
object
2 properties
KnowledgeBaseGetResponsesContentApplicationJsonSchemaResponseKnowledgeBasesItems
object
3 properties
AssistantsModelIdPhoneNumbersPhoneNumberSlugDeleteResponsesContentApplicationJsonSchemaDetail
object
4 properties
4 required
Create-simulation-caseRequestUnprocessableEntityError
object
get-simulation-scenario_Response_200
object
2 properties
Start-ws-media-callRequestBadGatewayError
object
2 properties
ActionsPostRequestBodyContentApplicationJsonSchemaCustomEval
object
1 property
LiveTransferUpdateDirectPhoneConfig
object
17 properties
4 required
SubaccountsSubaccountIdGetResponsesContentApplicationJsonSchemaResponse
object
1 property
SubaccountsSubaccountIdGetResponsesContentApplicationJsonSchemaResponseSubaccountsItemsPermissions
object
13 properties
VoicesGetResponsesContentApplicationJsonSchemaResponse
object
2 properties
List-simulation-suitesRequestBadRequestError
object
AssistantsPostRequestBodyContentApplicationJsonSchemaAgentEndCallReasonsV2ItemsClosingMessageMode
string
Controls how the farewell message is generated. static: message is spoken verbatim. prompt: message is an instruction to the LLM. none: LLM generates its own f…
create-action_Response_200
object
2 properties
SimulationCaseCreateInType
string
Simulation case type.
Create-assistantRequestBadRequestError
object
1 property
LiveTransferUpdateDirectPhoneConfigTransferMode
string
Transfer mode.
AnalyticsGetResponsesContentApplicationJsonSchemaDurationMetricsSeriesItems
object
4 properties
ActionsActionIdPutRequestBodyContentApplicationJsonSchemaIncallSms
object
5 properties
ListKnowledgeBaseSourcesRequestBadRequestError
object
CallsCallIdGetResponsesContentApplicationJsonSchemaResponseCallsItems
object
25 properties
ActionsActionIdGetResponsesContentApplicationJsonSchemaResponseActionsItemsInputVariablesValuesItemsType
string
delete-action_Response_200
object
2 properties
timezone
string
The agent's timezone.
CallsCallIdGetResponsesContentApplicationJsonSchemaResponseCallsItemsStatus
string
The current status of the call.
Update-knowledge-base-sourceRequestBadRequestError
object
SimulationCaseCreateInCallSuccessType
string
Success logic for the case.
knowledgeBaseSourceDelete_Response_200
object
2 properties
ActionsActionIdGetResponsesContentApplicationJsonSchemaResponseActionsItemsInputVariablesAssistantsItemsAttachmentType
string
SubaccountsSubaccountIdPutRequestBodyContentApplicationJsonSchemaOperationType
string
The type of operation to perform. You can import objects from the parent workspace to a subaccount or return objects from a subaccount in some cases.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Synthflow 7
Other APIs Synthflow publishes across the network.
Synthflow Platform API
Synthflow Chat API
Synthflow Contacts API
Synthflow MCP API
Synthflow Memory Stores API
Synthflow Phone Numbers API
Synthflow Webhook Logs API
Where this information came from
This is an independent, third-party profile of Synthflow Default API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.