Phonic conversations 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 Conversations. 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
12 operations
across 9 paths,
and defines 74 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.
conversations_evaluate_Response_201
object
1 property
1 required
ConversationsIdEvalsPostResponsesContentApplicationJsonSchemaEvaluation
object
1 property
1 required
ConversationsListResponseConversationsPagination
object
2 properties
2 required
ConversationExtraction
object
4 properties
4 required
EvaluateConversationRequest
object
1 property
1 required
OutboundCallInitiatedResponse
object
2 properties
2 required
DataRetentionPolicyOneOf1Transcripts
object
1 property
1 required
Conversation
object
51 properties
36 required
conversations_list_evaluations_Response_200
object
1 property
1 required
ValidationErrorError
object
1 property
1 required
ConversationEndedBy
string
Who or what ended the conversation.
ConversationExtractionSchema
object
3 properties
3 required
conversations_outbound_call_Response_200
ConversationBackgroundNoise
string
The background noise type used in the conversation.
BasicErrorError
object
2 properties
1 required
conversations_replay_Response_200
object
1 property
1 required
conversations_list_extractions_Response_200
object
1 property
1 required
ConversationItemToolCallsItemsRequestBody
The request body sent to the tool. Can be any JSON-serializable value.
conversations_get_analysis_Response_200
object
1 property
1 required
OutboundCallConfigConfigurationEndpoint
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
ConversationOrigin
string
The origin of the conversation.
OutboundCallRequest
object
3 properties
1 required
DataRetentionPolicy0
object
Zero data retention mode. No transcripts or audio recordings are retained.
1 property
1 required
ConversationsIdGetParametersAudioContainer
string
ConversationAnalysis
object
3 properties
3 required
conversations_delete_Response_200
object
1 property
1 required
DataRetentionPolicyOneOf1AudioRecordings
object
1 property
1 required
conversations_cancel_Response_200
object
1 property
1 required
ConversationEvaluationResultResult
string
The evaluation result.
ConversationItem
object
12 properties
7 required
ListConversationsResponse
object
2 properties
2 required
SipCallErrorError
object
4 properties
4 required
conversations_list_Response_200
ConversationsIdEvalsPostResponsesContentApplicationJsonSchemaEvaluationResult
string
The evaluation result.
OutboundCallConfigMultilingualMode
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…
ConversationEvaluationResultPrompt
object
The evaluation prompt information.
2 properties
2 required
ConversationItemRole
string
Who spoke in this turn.
ConversationEvaluationResult
object
4 properties
4 required
ConversationAgent
object
The agent associated with the conversation.
3 properties
3 required
OutboundDryRunResponse
object
2 properties
2 required
ConversationMultilingualMode
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…
GetConversationByExternalIdResponse
object
1 property
1 required
SipOutboundDryRunResponse
object
3 properties
3 required
BasicError
object
1 property
ValidationError
object
2 properties
2 required
DataRetentionPolicy1
object
Standard data retention with configurable deletion windows.
3 properties
3 required
LanguageCode
string
ISO 639-1 language codes supported by the agent
conversations_sip_outbound_call_Response_200
OutboundCallConfigToolsItems0
string
Built-in tool
SipCallError
object
1 property
1 required
OutboundCallConfigModel
string
The speech-to-speech model to use.
DataRetentionPolicy
Controls how long transcripts and audio recordings are retained before deletion. When zerodataretention is true, nothing is retained and transcripts/audiorecor…
ConversationProject
object
The project associated with the conversation.
2 properties
2 required
Task
object
2 properties
2 required
OutboundNumberPool
object
Pool of phone numbers used for outbound calls.
2 properties
2 required
ConversationCallInfo
object
Phone call metadata. null for non-phone call conversations.
3 properties
2 required
PostConversationsSipOutboundCallRequestBadRequestError
ReplayConversationRequest
object
1 property
ConversationPronunciationDictionaryItems
object
2 properties
2 required
OutboundCallConfigToolsItems
ConversationDeletionInfo
object
Information about when transcripts and audio recordings are or were scheduled to be deleted.
2 properties
2 required
ConversationsGetParametersAudioContainer
string
OutboundCallConfigIntelligenceLevel
string
The intelligence level of the agent. high uses a more capable model for more complex reasoning, while standard is optimized for lower latency.
conversations_extract_data_Response_201
object
1 property
1 required
ExtractDataRequest
object
1 property
1 required
ConversationItemToolCallsItemsTool
object
2 properties
2 required
conversations_get_Response_200
object
1 property
1 required
ConversationItemToolCallsItems
object
15 properties
6 required
SipOutboundCallInitiatedResponse
object
3 properties
3 required
OutboundCallConfigBackgroundNoise
string
The background noise type. Can be "office", "call-center", "coffee-shop", or null.
OutboundCallConfig
object
When an agent is provided, these config options override the agent settings.
35 properties
OutboundCallConfigPronunciationDictionaryItems
object
2 properties
2 required
SipCallErrorErrorCode
string
Machine-readable error code.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Phonic publishes across the network.
