Phonic agents API is one of 10 APIs that Phonic publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include Agents. The published artifact set on APIs.io includes an OpenAPI specification, an AsyncAPI specification, API documentation, an API reference, and a getting-started guide.
This API exposes
9 operations
across 5 paths,
and defines 65 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against a single base URL, https://api.phonic.ai/v1.
The identity and technical contract details declared by the specification.
AgentsNameOrIdPhoneNumbersPatchRequestBodyContentApplicationJsonSchemaConfigurationEndpoint
object
When not null, the agent will call this endpoint to get configuration options for calls on this phone number.
3 properties
1 required
DataRetentionPolicyOneOf1Transcripts
object
1 property
1 required
AgentsNameOrIdCustomPhoneNumbersPostRequestBodyContentApplicationJsonSchemaConfigurationEndpoint
object
When not null, the agent will call this endpoint to get configuration options for calls on this phone number.
3 properties
1 required
AgentPronunciationDictionaryItems
object
2 properties
2 required
CreateAgentRequest
object
46 properties
1 required
ValidationErrorError
object
1 property
1 required
AgentObservabilityIntegrationsItems
string
UpdateAgentRequestConfigurationEndpoint
object
When not null, at the beginning of the conversation the agent will make a POST request to this endpoint to get configuration options.
3 properties
1 required
UpsertAgentRequest
object
48 properties
1 required
CreateAgentRequestObservabilityIntegrationsItems
string
agents_upsert_Response_200
object
3 properties
3 required
CreateAgentRequestToolsItems
agents_update_phone_number_Response_200
object
1 property
1 required
Agent
object
47 properties
32 required
agents_add_custom_phone_number_Response_200
object
1 property
1 required
AgentProject
object
The project the agent belongs to.
2 properties
2 required
BasicErrorError
object
2 properties
1 required
UpdateAgentRequestToolsItems0
string
Built-in tool
CreateAgentRequestConfigurationEndpoint
object
When not null, at the beginning of the conversation the agent will make a POST request to this endpoint to get configuration options.
3 properties
1 required
UpdateAgentRequestToolsItems
CreateAgentRequestMultilingualMode
string
If "auto", each user audio is automatically identified for the language to respond in. If "request", user must request to change language (recommended). If "in…
BuiltInToolConfigSpeechBeforeToolCall
string
Controls whether the assistant speaks before the tool is called. required: the assistant must speak first. optional: the model decides. suppressed: the assista…
agents_get_Response_200
object
1 property
1 required
UpdateAgentRequestIntelligenceLevel
string
The intelligence level of the agent. high uses a more capable model for more complex reasoning, while standard is optimized for lower latency.
CreateAgentRequestPhoneNumber
string
When set to null, the agent will not be associated with a phone number. When set to "assign-automatically", the agent will be assigned a random phone number. W…
DataRetentionPolicy0
object
Zero data retention mode. No transcripts or audio recordings are retained.
1 property
1 required
CreateAgentRequestTemplateVariables
object
2 properties
1 required
DataRetentionPolicyOneOf1AudioRecordings
object
1 property
1 required
CreateAgentRequestPronunciationDictionaryItems
object
2 properties
2 required
CreateAgentRequestIntelligenceLevel
string
The intelligence level of the agent. high uses a more capable model for more complex reasoning, while standard is optimized for lower latency.
AgentAudioFormat
string
The audio format of the agent. If the agent has a phone number, the audio format will be mulaw8000.
agents_update_Response_200
object
3 properties
3 required
AgentMultilingualMode
string
If "auto", each user audio is automatically identified for the language to respond in. If "request", user must request to change language (recommended). If "in…
AgentConfigurationEndpoint
object
When not null, the agent will call this endpoint to get configuration options.
3 properties
3 required
BuiltInToolConfigs
object
Per-tool configuration overrides for built-in tools, keyed by built-in tool ID (e.g. toolnaturalconversationending). A built-in tool referenced in tools but ab…
AgentTemplateVariables
object
1 property
1 required
UpdateAgentRequestBackgroundNoise
string
The background noise type. Can be "office", "call-center", "coffee-shop", or null.
CreateAgentRequestToolsItems0
string
Built-in tool
UpdateAgentRequestObservabilityIntegrationsItems
string
CreateAgentRequestBackgroundNoise
string
The background noise type. Can be "office", "call-center", "coffee-shop", or null.
UpdateAgentRequestPhoneNumber
string
When set to null, the agent will not be associated with a phone number anymore. When set to "assign-automatically", the agent will be assigned a random phone n…
UpdateAgentRequestPronunciationDictionaryItems
object
2 properties
2 required
CreateAgentRequestAudioFormat
string
The audio format of the agent.
agents_delete_custom_phone_number_Response_200
object
1 property
1 required
ValidationError
object
2 properties
2 required
DataRetentionPolicy1
object
Standard data retention with configurable deletion windows.
3 properties
3 required
UpdateAgentRequestTemplateVariables
object
2 properties
1 required
LanguageCode
string
ISO 639-1 language codes supported by the agent
agents_delete_Response_200
object
1 property
1 required
UpdateAgentRequestMultilingualMode
string
If "auto", each user audio is automatically identified for the language to respond in. If "request", user must request to change language (recommended). If "in…
BasicError
object
1 property
AgentIntegration
object
A third-party integration enabled for an agent.
4 properties
4 required
UpdateAgentRequest
object
49 properties
DataRetentionPolicy
Controls how long transcripts and audio recordings are retained before deletion. When zerodataretention is true, nothing is retained and transcripts/audiorecor…
AgentToolsItems0
string
Built-in tool
Task
object
2 properties
2 required
UpdateAgentRequestAudioFormat
string
The audio format of the agent.
OutboundNumberPool
object
Pool of phone numbers used for outbound calls.
2 properties
2 required
AgentIntelligenceLevel
string
The intelligence level of the agent. high uses a more capable model for more complex reasoning, while standard is optimized for lower latency.
agents_list_Response_200
object
1 property
1 required
agents_create_Response_201
object
2 properties
2 required
BuiltInToolConfig
object
Configuration for a simple built-in tool (keypadinput, naturalconversationending, or choosenottorespond).
1 property
1 required
AgentBackgroundNoise
string
The background noise type. Can be "office", "call-center", "coffee-shop", or null.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Phonic publishes across the network.