Create an agent | Synthflow

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

agentobjectRequired

namestringRequired

Agent name.

typeenumRequired

Agent type.

Allowed values:

descriptionstringOptional

Agent description.

end_call_reasonslist of stringsOptional

Custom conditions that trigger automatic call termination. When the AI agent detects one of these conditions during a conversation, it will say a brief farewell and end the call.

external_webhook_urlstringOptional

URL of the webhook that should receive data after the call, such as the transcript.

inbound_call_webhook_urlstringOptional

The URL for your inbound webhook. For more details on inbound webhooks, see About inbound call webhooks.

is_recordingbooleanOptional

Whether the conversation should be recorded.

max_durationobjectOptional

phone_numberstringOptional

The phone number attached to the agent.

voicemail_messageobjectOptional

Configuration for the message left when a voicemail is detected. Requires greeting_message_mode to be set to human.

Response

200

statusstring

Whether the request was successful.

responseobject

detailsobject

Errors

400

Bad Request Error

1	import requests
2
3	url = "https://api.synthflow.ai/v2/assistants"
4
5	payload = {
6	"agent": {
7	"greeting_message": "Hello, this is Sarah from Acme Corp. How can I help you today?",
8	"language": "en-US",
9	"llm": "gpt-4.1-Mini",
10	"prompt": "You are a helpful sales assistant for Acme Corp.",
11	"voice_id": "eleven_turbo_v2"
12	},
13	"name": "Sales Assistant",
14	"type": "outbound"
15	}
16	headers = {
17	"Authorization": "Bearer <token>",
18	"Content-Type": "application/json"
19	}
20
21	response = requests.post(url, json=payload, headers=headers)
22
23	print(response.json())

1	{
2	"status": "ok",
3	"response": {
4	"model_id": "1726559381711x108708587477942990"
5	},
6	"details": {
7	"phone": "",
8	"voice": ""
9	}
10	}