Synthflow
App · 20 actions
Read agents and calls, manage contacts and memory stores, and inspect actions and chats.
Actions
| Action | What it does |
|---|---|
| Create contact | Create contact. |
| Create memory store | Create memory store. |
| Delete contact | Delete contact. |
| Delete memory store | Delete memory store. |
| Get action | Get action. |
| Get agent | Get agent. |
| Get batch call | Get batch call. |
| Get call | Get call. |
| Get chat | Get chat. |
| Get contact | Get contact. |
| Get memory store | Get memory store. |
| List actions | List actions. |
| List agents | List agents. |
| List batch calls | List batch calls. |
| List calls | List calls. |
| List chats | List chats. |
| List contacts | List contacts. |
| List memory stores | List memory stores. |
| Update contact | Update contact. |
| Update memory store | Update memory store. |
Create contact
Create contact.
Inputs
- Name
nametextRequired - The contact's name.
- Phone number
phone_numbertextRequired - The contact's phone number.
- Email
emailtext - The contact's email address.
- Contact metadata
contact_metadataobject - Additional metadata for the contact.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"response": {
"id": "example"
},
"status": "example"
}
}Create memory store
Create memory store.
Inputs
- Title
titletext - Memory store name.
- Description
descriptiontext - Memory store description.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"response": {
"created_at": "example",
"description": "example",
"id": "example",
"number_of_agents": 1,
"number_of_contacts": 1,
"title": "example",
"updated_at": "example",
"workspace_id": "example"
},
"status": "example"
}
}Delete contact
Delete contact.
Inputs
- Contact ID
contact_idtextRequired - Contact ID.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"status": "example"
}
}Delete memory store
Delete memory store.
Inputs
- Memory store ID
memory_store_idtextRequired - The ID of the memory store (group).
Outputs
dataobject- Returned value.
Example output
{
"data": {
"status": "example"
}
}Get action
Get action.
Inputs
- Action
action_idtextRequired - To find an action's ID, go to its page in your Synthflow dashboard.
- Include assistants
include_assistantstrue/false - Include assistant IDs assigned to this action.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"response": {
"actions": []
},
"status": "example"
}
}Get agent
Get agent.
Inputs
- Model
model_idtextRequired - Agent ID. You can find it on the agent’s page in your dashboard.
- Include actions
include_actionstrue/false - Include action IDs and `input_variables` (each with the action's `trigger_condition`, `attachment_type`, and `input_variables_mapping`) grouped by `action_id`.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"response": {
"assistants": [],
"pagination": {
"limit": 1,
"offset": 1,
"total_records": 1
}
},
"status": "example"
}
}Get batch call
Get batch call.
Inputs
- Batch call
batch_call_idtextRequired - The batch returned by `POST /calls/batch`, a UUID.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"response": {
"agent_name": "example",
"batch_call_id": "example",
"created_at": "example",
"dispatched_count": 1,
"failed_count": 1,
"from_phone_number": "example",
"model_id": "example",
"name": "example",
"pending_count": 1,
"status": "example",
"total_task_count": 1
},
"status": "example"
}
}Get call
Get call.
Inputs
- Call ID
call_idtextRequired - Call ID. You can find it on the logs page in your dashboard.
- Include all actions
include_all_actionstrue/false - Include all_executed_actions in the response.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"response": {
"calls": [],
"pagination": {
"limit": 1,
"offset": 1,
"total_records": 1
}
},
"status": "example"
}
}Get chat
Get chat.
Inputs
- Chat
chat_idtextRequired - Chat ID.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"response": {
"chat_id": "example",
"chat_status": "ongoing",
"conversation_history": [],
"fsm_log": {},
"initial_message": {
"agent_message": "example",
"current_state": "example",
"timestamp": "example",
"turn_number": 1
},
"start_timestamp": "example",
"transcript": "example"
},
"status": "example"
}
}Get contact
Get contact.
Inputs
- Contact ID
contact_idtextRequired - Contact ID.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"response": {
"contact_metadata": {
"company": "example"
},
"created_at": "example",
"email": "example",
"id": "example",
"memory_store_ids": [],
"name": "example",
"phone_number": "example",
"updated_at": "example",
"workspace_id": "example"
},
"status": "example"
}
}Get memory store
Get memory store.
Inputs
- Memory store ID
memory_store_idtextRequired - The memory store's ID.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"response": {
"contact_ids": [],
"created_at": "example",
"id": "example",
"title": "example",
"updated_at": "example",
"workspace_id": "example"
},
"status": "example"
}
}List actions
List actions.
Inputs
- Limit
limitnumber - Actions displayed per page.
- Offset
offsetnumber - Index of the first action to be returned.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"response": {
"actions": [],
"next_offset": 1,
"pagination": {
"limit": 1,
"offset": 1,
"total_records": 1
}
},
"status": "example"
}
}List agents
List agents.
Inputs
- Limit
limitnumber - Agents displayed per page.
- Offset
offsetnumber - Index of the first agent to be returned.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"response": {
"assistants": [],
"next_offset": 1,
"pagination": {
"limit": 1,
"offset": 1,
"total_records": 1
}
},
"status": "example"
}
}List batch calls
List batch calls.
Inputs
- Limit
limitnumber - Number of batches per page, between 1 and 100.
- Offset
offsetnumber - Number of batches to skip.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"response": {
"batch_calls": [],
"next_offset": 1,
"pagination": {
"limit": 1,
"offset": 1,
"total_records": 1
}
},
"status": "example"
}
}List calls
List calls.
Inputs
- Model
model_idtextRequired - The calls for the specified model ID will be returned
- Limit
limitnumber - How many calls will be displayed in every page, default is 20
- Offset
offsetnumber - Index of the first call to be returned.
- From date
from_datedate and time - Begin timestamp (milliseconds since epoch) of the call. Available after the call starts. Example: 1732546200000
- To date
to_datedate and time - End timestamp (milliseconds since epoch) of the call. Available after the call ends. Example: 1732546200000
- Call status
call_statustext - Status of call.
- Duration min
duration_minnumber - Only retrieve calls with duration greater than or equal to this value (seconds).
- Duration max
duration_maxnumber - Only retrieve calls with duration less than or equal to this value (seconds).
- Lead phone number
lead_phone_numbertext - Phone number of the caller or callee (E.164 format preferred) and URL-encode the leading "+" (e.g. %2B14155552671)
- Action
action_idtext - Only retrieve calls that executed this action. Calls made before May 20, 2026 can't be filtered by action.
- Include all actions
include_all_actionstrue/false - Include all_executed_actions in the response.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"response": {
"calls": [],
"next_offset": 1,
"pagination": {
"limit": 1,
"offset": 1,
"total_records": 1
}
},
"status": "example"
}
}List chats
List chats.
Inputs
- Agent
agent_idtext - Filter chats by agent ID.
- Limit
limitnumber - Limit the number of chats to return.
- Cursor
cursortext - Cursor to start from.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"response": {
"chats": [],
"has_more": false,
"next_cursor": "example"
},
"status": "example"
}
}List contacts
List contacts.
Inputs
- Search
searchtext - The contact's phone number.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"response": {
"items": [],
"page_number": 1,
"page_size": 1,
"total": 1
},
"status": "example"
}
}List memory stores
List memory stores.
Inputs
- Search
searchtext - The memory store's title.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"response": {
"items": [],
"page_number": 1,
"page_size": 1,
"total": 1
},
"status": "example"
}
}Update contact
Update contact.
Inputs
- Contact ID
contact_idtextRequired - The contact's ID.
- Name
nametext - The contact's name.
- Phone number
phone_numbertext - The contact's phone number.
- Email
emailtext - The contact's email.
- Contact metadata
contact_metadataobject - Contact metadata.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"status": "example"
}
}Update memory store
Update memory store.
Inputs
- Memory store ID
memory_store_idtextRequired - The ID of the memory store (group).
- Title
titletext - Memory store name.
- Description
descriptiontext - Memory store description.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"id": "example"
}
}