Real-time speech-to-speech (STS) communication WebSocket API for Phonic's AI voice conversation platform.
All connections require authentication using one of the following methods:
#### Option 1: API Key (Server-side)
Use your Phonic API key in the Authorization header:
`Authorization: Bearer PHONIC_API_KEY`
#### Option 2: Session Token (Client-side)
For client-side applications where you don't
Provider:PhonicAsyncAPI: v2.6.0Spec: API ReferenceOperations: 2Messages: 29
Channel address
/v1/sts/ws
Operations
publish
conversations-publish
Server messages
subscribe
conversations-subscribe
Client messages
Messages
ready_to_start_conversation
ready_to_start_conversation
Content-Type:
conversation_created
conversation_created
Content-Type:
input_text
input_text
Content-Type:
input_cancelled
input_cancelled
Content-Type:
audio_chunk
audio_chunk
Content-Type:
user_started_speaking
user_started_speaking
Content-Type:
user_finished_speaking
user_finished_speaking
Content-Type:
assistant_started_speaking
assistant_started_speaking
Content-Type:
assistant_finished_speaking
assistant_finished_speaking
Content-Type:
dtmf
dtmf
Content-Type:
tool_call
tool_call
Content-Type:
tool_call_output_processed
tool_call_output_processed
Content-Type:
tool_call_interrupted
tool_call_interrupted
Content-Type:
assistant_chose_not_to_respond
assistant_chose_not_to_respond
Content-Type:
assistant_ended_conversation
assistant_ended_conversation
Content-Type:
error
error
Content-Type:
warning
warning
Content-Type:
config
config
Content-Type:
audio_chunk
audio_chunk
Content-Type:
update_system_prompt
update_system_prompt
Content-Type:
add_system_message
add_system_message
Content-Type:
update_tools_subset
update_tools_subset
Content-Type:
set_external_id
set_external_id
Content-Type:
tool_call_output
tool_call_output
Content-Type:
unmute
unmute
Content-Type:
mute
mute
Content-Type:
generate_reply
generate_reply
Content-Type:
say
say
Content-Type:
reset
reset
Content-Type:
About AsyncAPI
The AsyncAPI specification describes event-driven APIs the way OpenAPI describes request/response APIs. A channel is the named pipe — a webhook URL, a Kafka topic, a WebSocket route, an MQTT subject — that producers and consumers publish or subscribe to. Each channel carries one or more messages with structured payloads, and an operation declares whether a given party sends or receives on that channel.
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.