About AgentPhone
Review the Service identity, supported languages, protocol versions, and source metadata discovered by the directory.Service details
Service Id
bd3009b6-0fd7-4765-adba-258344bb67c4
Service origin
https://api.agentphone.ai
ListedSeptember 24, 2026, 11:41 PM
Last checkedSeptember 24, 2026, 11:41 PM
Protocol details
SourceOpenAPI
Endpoints
Endpoint details are saved from the OpenAPI document. Authentication requirements and prices are advertised information, not a verified payment or access guarantee. The document may contain additional endpoints.POST/v1/agents
Create Agent
Create a new agent. An agent represents an AI persona (Support Bot, Sales Agent, etc.) that can have phone numbers attached to it. voiceMode: "webhook" (default) forwards transcripts to your webhook. "hosted" uses a built-in LLM with systemPrompt (no webhook needed).Price unavailableThe operation requires declared authentication; API keys, bearer tokens and other schemes are not evidence of AEP support.GET/v1/agents/voices
List Voices
Return available voices from the call provider (Retell).Price unavailableThe operation requires declared authentication; API keys, bearer tokens and other schemes are not evidence of AEP support.DELETE/v1/agents/{agent_id}
Delete Agent
Delete an agent. Phone numbers, conversations, and calls associated with the agent will have their agent reference cleared (set to null) but will not be deleted themselves.Price unavailableThe operation requires declared authentication; API keys, bearer tokens and other schemes are not evidence of AEP support.GET/v1/agents/{agent_id}
Get Agent
Get a single agent with its attached numbers.Price unavailableThe operation requires declared authentication; API keys, bearer tokens and other schemes are not evidence of AEP support.PATCH/v1/agents/{agent_id}
Update Agent
Update an agent's configuration. Use this to change voice mode, system prompt, greeting, or voice. Switching voiceMode to "hosted" re-provisions the voice agent with built-in LLM.Price unavailableThe operation requires declared authentication; API keys, bearer tokens and other schemes are not evidence of AEP support.GET/v1/agents/{agent_id}/calls
List Agent Calls
List all calls for an agent.Price unavailableThe operation requires declared authentication; API keys, bearer tokens and other schemes are not evidence of AEP support.GET/v1/agents/{agent_id}/conversations
List Agent Conversations
List all conversations for an agent.Price unavailableThe operation requires declared authentication; API keys, bearer tokens and other schemes are not evidence of AEP support.POST/v1/agents/{agent_id}/numbers
Attach Number To Agent
Attach an existing phone number to an agent. The number must belong to the same account and not be released.Price unavailableThe operation requires declared authentication; API keys, bearer tokens and other schemes are not evidence of AEP support.DELETE/v1/agents/{agent_id}/numbers/{number_id}
Detach Number From Agent
Detach a phone number from an agent (sets agentId to null). The number remains active and can be re-attached to any agent.Price unavailableThe operation requires declared authentication; API keys, bearer tokens and other schemes are not evidence of AEP support.DELETE/v1/agents/{agent_id}/webhook
Delete Agent Webhook
Remove the webhook for a specific agent.Price unavailableThe operation requires declared authentication; API keys, bearer tokens and other schemes are not evidence of AEP support.GET/v1/agents/{agent_id}/webhook
Get Agent Webhook
Get the webhook configuration for a specific agent.Price unavailableThe operation requires declared authentication; API keys, bearer tokens and other schemes are not evidence of AEP support.POST/v1/agents/{agent_id}/webhook
Create Or Update Agent Webhook
Register or update a webhook URL for a specific agent. When set, this agent's events are delivered here instead of the account default webhook.Price unavailableThe operation requires declared authentication; API keys, bearer tokens and other schemes are not evidence of AEP support.GET/v1/agents/{agent_id}/webhook/deliveries
List Agent Deliveries
Get recent webhook delivery attempts for a specific agent's webhook.Price unavailableThe operation requires declared authentication; API keys, bearer tokens and other schemes are not evidence of AEP support.POST/v1/agents/{agent_id}/webhook/test
Test Agent Webhook
Send a test webhook to the agent's webhook endpoint.Price unavailableThe operation requires declared authentication; API keys, bearer tokens and other schemes are not evidence of AEP support.POST/v1/calls
Create Outbound Call
Initiate an outbound call. This endpoint allows you to programmatically make phone calls from your agent to any phone number. Use `fromNumberId` to pick which of the agent's numbers to use as caller ID; if omitted, the first assigned number is used. Flow: 1. Validates the agent belongs to your account and has a phone number 2. Initiates a call from the agent's number to the destination 3. When recipient answers, speaks the initial greeting (if provided) 4. Listens for recipient's speech and sends to your webhook 5. Continues conversation using your webhook responsesPrice unavailableThe operation requires declared authentication; API keys, bearer tokens and other schemes are not evidence of AEP support.POST/v1/calls/web
Create Web Call
Create a browser-based web call. Returns an access token that your frontend passes to the AgentPhone Web SDK (`agentphone-web-sdk`) to start the call in the browser. The token expires 30 seconds after creation. Flow: 1. Validates the agent belongs to your account 2. Creates a web call and returns an access token 3. Your client calls `webClient.startCall({ accessToken })` to connect 4. Call lifecycle (transcripts, webhooks) works the same as phone callsPrice unavailableThe operation requires declared authentication; API keys, bearer tokens and other schemes are not evidence of AEP support.GET/v1/calls/{call_id}
Get Call
Get a specific call with its transcripts.Price unavailableThe operation requires declared authentication; API keys, bearer tokens and other schemes are not evidence of AEP support.POST/v1/calls/{call_id}/end
End Call
Terminate an ongoing call. Works for both hosted-mode and webhook-mode calls. The call_ended webhook from Retell updates status/endedAt asynchronously, so this endpoint returns the current call as soon as the stop request is accepted by Retell.Price unavailableThe operation requires declared authentication; API keys, bearer tokens and other schemes are not evidence of AEP support.GET/v1/calls/{call_id}/recording
Get Call Recording
Stream the audio recording for a specific call. Public bearer-link endpoint.Price unavailableGET/v1/calls/{call_id}/transcript
Get Call Transcript
Get the full transcript for a call. Returns the complete, ordered transcript regardless of the webhook contextLimit setting. Each entry contains the user utterance and the corresponding agent response (when available).Price unavailableThe operation requires declared authentication; API keys, bearer tokens and other schemes are not evidence of AEP support.GET/v1/calls/{call_id}/transcript/stream
Stream Call Transcript
Stream a call's transcript via Server-Sent Events. On connect the server replays all existing transcript turns from the database, then streams new turns in real time as they arrive from the voice provider. A ``: heartbeat`` comment is sent every 15 s to keep proxies alive. The stream closes after sending an ``ended`` event when the call completes (or immediately after replay if the call has already ended). Works for both live and completed calls — same URL either way.Price unavailableThe operation requires declared authentication; API keys, bearer tokens and other schemes are not evidence of AEP support.GET/v1/contacts
List Contacts
List all contacts for this account. Optional `search` query filters by name or phone number (case-insensitive contains).Price unavailableThe operation requires declared authentication; API keys, bearer tokens and other schemes are not evidence of AEP support.POST/v1/contacts
Create Contact
Create a new contact. Phone number is normalized to E.164 format. Returns 409 if a contact with this phone number already exists for the project.Price unavailableThe operation requires declared authentication; API keys, bearer tokens and other schemes are not evidence of AEP support.DELETE/v1/contacts/{contact_id}
Delete Contact
Delete a contact.Price unavailableThe operation requires declared authentication; API keys, bearer tokens and other schemes are not evidence of AEP support.GET/v1/contacts/{contact_id}
Get Contact
Get a single contact by ID.Price unavailableThe operation requires declared authentication; API keys, bearer tokens and other schemes are not evidence of AEP support.PATCH/v1/contacts/{contact_id}
Update Contact
Update a contact's fields. If phoneNumber is updated, it's re-normalized and checked for uniqueness (409 on conflict).Price unavailableThe operation requires declared authentication; API keys, bearer tokens and other schemes are not evidence of AEP support.GET/v1/conversations/{conversation_id}
Get Conversation
Get a conversation with its recent messages.Price unavailableThe operation requires declared authentication; API keys, bearer tokens and other schemes are not evidence of AEP support.PATCH/v1/conversations/{conversation_id}
Update Conversation
Update conversation metadata (state). Use this to store custom context for AI agents: - Customer information (name, account ID) - Business context (order ID, ticket number) - Session state (current topic, preferences) The metadata is included in webhook payloads as `conversationState`.Price unavailableThe operation requires declared authentication; API keys, bearer tokens and other schemes are not evidence of AEP support.GET/v1/conversations/{conversation_id}/messages
Get Conversation Messages
Get paginated messages for a conversation. Use before/after for cursor-based pagination.Price unavailableThe operation requires declared authentication; API keys, bearer tokens and other schemes are not evidence of AEP support.POST/v1/conversations/{conversation_id}/typing
Send Typing Indicator
Show a typing indicator in the conversation (iMessage only). Best-effort: providers may silently drop the indicator if the chat hasn't had recent activity, the recipient isn't on iMessage, or it's a group chat. Indicators auto-expire after a few seconds — no "stop typing" call needed.Price unavailableThe operation requires declared authentication; API keys, bearer tokens and other schemes are not evidence of AEP support.POST/v1/messages
Send Message
Send an outbound message (SMS or iMessage) via the provider assigned to the number.Price unavailableThe operation requires declared authentication; API keys, bearer tokens and other schemes are not evidence of AEP support.POST/v1/messages/{message_id}/reactions
Send Reaction
Send a tapback reaction to a message (iMessage only). Reactions are available only for iMessage messages. Attempting to react to an SMS message or another channel that does not support tapbacks returns a clear error.Price unavailableThe operation requires declared authentication; API keys, bearer tokens and other schemes are not evidence of AEP support.POST/v1/numbers
Create Number
Provision a new SMS-enabled phone number. 1. Check number limit (lifetime limit) 2. Search the account's configured SMS provider for available numbers 3. Purchase the first available one 4. Configure messaging and voice routing 5. Store the number in our databasePrice unavailableThe operation requires declared authentication; API keys, bearer tokens and other schemes are not evidence of AEP support.DELETE/v1/numbers/{number_id}
Delete Number
Release (delete) a phone number. This will: 1. Release the number from its upstream provider when supported 2. Mark the number as "released" in the database 3. Keep all messages and conversation history (for audit purposes) WARNING: This action is irreversible! The number cannot be recovered.Price unavailableThe operation requires declared authentication; API keys, bearer tokens and other schemes are not evidence of AEP support.GET/v1/numbers/{number_id}/calls
List Calls For Number
List all calls for a specific phone number.Price unavailableThe operation requires declared authentication; API keys, bearer tokens and other schemes are not evidence of AEP support.DELETE/v1/numbers/{number_id}/contact-card
Delete Contact Card
Remove the iMessage contact card from this number.Price unavailableThe operation requires declared authentication; API keys, bearer tokens and other schemes are not evidence of AEP support.GET/v1/numbers/{number_id}/contact-card
Get Contact Card
Fetch the iMessage contact card set on this number.Price unavailableThe operation requires declared authentication; API keys, bearer tokens and other schemes are not evidence of AEP support.PUT/v1/numbers/{number_id}/contact-card
Put Contact Card
Create or replace the iMessage contact card on this number.Price unavailableThe operation requires declared authentication; API keys, bearer tokens and other schemes are not evidence of AEP support.GET/v1/numbers/{number_id}/messages