List agents

GET

https://api.synthflow.ai/v2/assistants/

GET

/v2/assistants/

1 curl https://api.synthflow.ai/v2/assistants/ \
2      -H "Authorization: Bearer <token>"

Try it

200Retrieved

1 {
2   "status": "ok",
3   "response": {
4     "pagination": {
5       "total_records": 1,
6       "limit": 1,
7       "offset": 0
8     },
9     "assistants": {
10       "agent": {
11         "timezone": "Europe/Berlin",
12         "voice_prompt": "Speak softly and calmly.",
13         "voice_stability": 0.5,
14         "voice_similarity_boost": 0.5,
15         "voice_optimise_streaming_latency": 2,
16         "voice_style": 1,
17         "voice_use_speaker_boost": true,
18         "allowed_idle_time_seconds": 12,
19         "initial_pause_seconds": 1,
20         "transcriber_keywords": [
21           "Synthflow"
22         ],
23         "ring_pause_seconds": 1,
24         "background_noise": {
25           "enabled": true,
26           "type": "cafe",
27           "volume": 20
28         },
29         "noise_cancellation": "standard",
30         "realistic_filler_words": true,
31         "is_transcript_disabled": true,
32         "synthesizer_filter_words": [
33           "Paris",
34           "Detroit",
35           "NYC"
36         ],
37         "voice_synthesizer": "eleven_multilingual_v2",
38         "suppression_level": 0.5,
39         "interruption_fade_out": 1,
40         "voice_speed": 1.2,
41         "voice_volume": 1,
42         "min_words_to_interrupt": 0,
43         "prompt": "string",
44         "greeting_message": "Hi, this is Cindy from Synthflow, how can I help you?",
45         "llm": "gpt-4o",
46         "language": "multi",
47         "voice_id": "56WncaVghRJENNR1He3Y",
48         "patience_level": "low",
49         "send_user_idle_reminders": false,
50         "reminder_after_idle_time_seconds": 4,
51         "reminder_after_idle_message": "I'm still here. Do you have any questions?"
52       },
53       "description": {},
54       "external_webhook_url": "string",
55       "is_recording": true,
56       "max_duration": {
57         "duration_seconds": 1200,
58         "is_enabled": true
59       },
60       "model_id": "4ba429e6-dc96-4c0b-966f-9bdf689ccfa6",
61       "name": "Synthflow Customer Service",
62       "phone_number": "+18284265151",
63       "type": "outbound"
64     }
65   }
66 }

Lists all agents you have in your account.

Authentication

AuthorizationBearer

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

Query parameters

limitintegerOptionalDefaults to 20

Agents displayed per page.

offsetintegerOptionalDefaults to 0

Index of the first agent to be returned.

Response

200

statusstring or null

Whether the request was successful.

responseobject or null

Authentication

Query parameters

Response

Errors