How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Synthflow Chat API

The chat API from Synthflow — 4 operation(s) for chat.

Synthflow Chat API is one of 8 APIs that Synthflow publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Chat. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 4 paths, and defines 32 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.

6 operations 4 paths 32 schemas 1 DELETE2 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.synthflow.ai
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Synthflow Chat API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (sec0).

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

chat 6
POST
/chat/{chat_id}
Create a chat
create-chat 1 param body → 200400
GET
/chat/{chat_id}
Get a chat
get-chat 2 params → 200400
DELETE
/chat/{chat_id}
Delete a chat
delete-chat 2 params → 200400
GET
/chat
List chats
list-chats 4 params → 200400
POST
/chat/{chat_id}/messages
Send a message in a chat
send-chat-message 1 param body → 200400
POST
/chat/outbound
Start an outbound chat conversation
create-outbound-chat 1 param body → 200400

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are FSMAgentLog (8 properties), ChatResponse (7 properties), OutboundChatRequest (7 properties), ChatMessage (5 properties). Each schema is shown below with its type and property counts.

OutboundChatTemplate
object
Twilio Content Template to use for outbound WhatsApp delivery.
2 properties 1 required
OutboundChatResponseResponse
object
1 property 1 required
Chat_delete-chat_Response_200
object
1 property
Create-chatRequestBadRequestError
object
Chat_get-chat_Response_200
object
2 properties
FSMAgentLog
object
FSM execution log for a specific agent in the chat session.
8 properties 7 required
OutboundChatRequestChannel
string
Outbound messaging channel.
OutboundChatRequest
object
Request to start an outbound SMS or WhatsApp chat conversation.
7 properties 4 required
Delete-chatRequestBadRequestError
object
ChatMessageResponse
object
Response from sending a message in a chat.
4 properties 4 required
ChatResponse
object
Chat session details.
7 properties 5 required
FsmAgentLogVariables
object
2 properties
ChatResponseInitialMessage
object
The initial message sent by the agent when the chat was created.
4 properties
Chat_list-chats_Response_200
object
2 properties
Send-chat-messageRequestBadRequestError
object
ChatGetResponsesContentApplicationJsonSchemaResponseChatsItems
object
3 properties 3 required
Create-outbound-chatRequestBadRequestError
object
ChatMessage
object
A single message in a chat conversation.
5 properties 5 required
ChatGetResponsesContentApplicationJsonSchemaResponseChatsItemsChatStatus
string
FsmAgentLogFsmMetadata
object
Metadata about the FSM.
1 property
FsmEventEventType
string
Type of the event.
Chat_send-chat-message_Response_200
object
2 properties
Chat_create-chat_Response_200
object
2 properties
status
string
Whether the request was successful.
List-chatsRequestBadRequestError
object
FSMEvent
object
A single FSM event.
4 properties 4 required
OutboundChatResponse
object
Response returned after an outbound chat conversation is created.
2 properties 2 required
FsmAgentLogExecutionStats
object
Statistics about FSM execution.
3 properties
ChatResponseChatStatus
string
Current status of the chat session.
Get-chatRequestBadRequestError
object
ChatGetResponsesContentApplicationJsonSchemaResponse
object
3 properties 3 required
FsmAgentLogVariablesValue
The collected value of the variable.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

synthflow-chat-api-openapi.yml Raw ↑

Other APIs Synthflow publishes across the network.

Synthflow Platform API
Synthflow Default 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 Chat 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.