API Reference

Make Call

post
https://api.synthflow.ai/v2/calls

Initiates a real-time phone call through the AI assistant.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Model-ID which you can obtain from your Synthflow Agent Page

string

The ID of the team can be obtained by opening a team and under the name of the team you should be able to copy it

string
required

Phone number that the call goes to

string
required

Name of the person that gets called

custom_variables
array of objects

Key-Value pairs of custom variables that you can dynamically inject into the prompt. Learn more.

custom_variables
string

Optional email of the lead for appointment booking.

string

Optional time zone name of the lead for appointment booking. List of possible time zones.

string

A prompt that will be used

string

The greeting that the assistant will say

Responses

Updated 11 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 months ago

Did this page help you?