- Bucket
- IP Addresses
- IP Ranges
- SIM Cards
- Purchase eSIMsPOST
- Register SIM cardsPOST
- List SIM card data usage notificationsGET
- Create a new SIM card data usage notificationPOST
- Delete SIM card data usage notificationsDELETE
- Get a single SIM card data usage notificationGET
- Updates information for a SIM Card Data Usage NotificationPATCH
- Get all SIM cardsGET
- Request bulk setting SIM card public IPs.POST
- Validate SIM cards registration codesPOST
- Deletes a SIM cardDELETE
- Get SIM cardGET
- Update a SIM cardPATCH
- Request a SIM card disablePOST
- Request a SIM card enablePOST
- Request removing a SIM card public IPPOST
- Request setting a SIM card public IPPOST
- Request setting a SIM card to standbyPOST
- Get activation code for an eSIMGET
- Get SIM card device detailsGET
- Get SIM card public IP definitionGET
- List wireless connectivity logsGET
- Addresses
- Advanced Number Orders
- Assistants
- Audio
- Chat
- Clusters
- Conversations
- Embeddings
- Fine Tuning
- Audit Logs
- Authentication Providers
- Phone Number Search
- Billing
- Billing Groups
- Brands
- SIM Card Actions
- Bundles
- User Bundles
- Call Control Applications
- Debugging
- Call Commands
- Dial
- Start AI Assistant
- Stop AI Assistant
- Answer call
- Bridge calls
- Update client state
- Enqueue call
- Forking start
- Forking stop
- Gather
- Gather stop
- Gather using AI
- Gather using audio
- Gather using speak
- Hangup call
- Remove call from a queue
- Play audio URL
- Stop audio playback
- Record pause
- Record resume
- Recording start
- Recording stop
- SIP Refer a call
- Reject a call
- Send DTMF
- Send SIP info
- SIPREC start
- SIPREC stop
- Speak text
- Streaming start
- Streaming stop
- Noise Suppression Start (BETA)
- Noise Suppression Stop (BETA)
- Transcription start
- Transcription stop
- Transfer call
- Call Information
- Campaign
- Voice Channels
- Phone Number Orders
- Retrieve all comments
- Create a comment
- Retrieve a comment
- Mark a comment as read
- Retrieve a list of phone numbers associated to orders
- Retrieve a single phone number within a number order.
- Update requirements for a single phone number within a number order.
- List number orders
- Create a number order
- Retrieve a number order
- Update a number order
- List sub number orders
- Retrieve a sub number order
- Update a sub number order's requirements
- Cancel a sub number order
- Create a sub number orders report
- Retrieve a sub number orders report
- Download a sub number orders report
- Conference Commands
- List conferences
- Create conference
- List conference participants
- Retrieve a conference
- Hold conference participants
- Join a conference
- Leave a conference
- Mute conference participants
- Play audio to conference participants
- Conference recording pause
- Conference recording resume
- Conference recording start
- Conference recording stop
- Speak text to conference participants
- Stop audio being played on the conference
- Unhold conference participants
- Unmute conference participants
- Update conference participant
- Connections
- Country Coverage
- Credential Connections
- Call Recordings
- Delete a stored credential
- Retrieve a stored credential
- Create a custom storage credential
- Update a stored credential
- List all recording transcriptions
- Delete a recording transcription
- Retrieve a recording transcription
- List all call recordings
- Delete a list of call recordings
- Delete a call recording
- Retrieve a call recording
- Customer Service Record
- Detail Records
- Dialogflow Integration
- Documents
- Dynamic Emergency Addresses
- Dynamic Emergency Endpoints
- Enum
- External Connections
- List all External Connections
- Creates an External Connection
- List all log messages
- Dismiss a log message
- Retrieve a log message
- Deletes an External Connection
- Retrieve an External Connection
- Update an External Connection
- List all civic addresses and locations
- Retrieve a Civic Address
- Update a location's static emergency address
- List all phone numbers
- Retrieve a phone number
- Update a phone number
- List all Releases
- Retrieve a Release request
- List all Upload requests
- Creates an Upload request
- Refresh the status of all Upload requests
- Get the count of pending upload requests
- Retrieve an Upload request
- Retry an Upload request
- Refresh Operator Connect integration
- Programmable Fax Applications
- Programmable Fax Commands
- FQDN Connections
- FQDNs
- Global IPs
- List all Global IP Allowed Ports
- Global IP Assignment Health Check Metrics
- List all Global IP assignments
- Create a Global IP assignment
- Delete a Global IP assignment
- Retrieve a Global IP
- Update a Global IP assignment
- Global IP Assignment Usage Metrics
- List all Global IP Health check types
- List all Global IP health checks
- Create a Global IP health check
- Delete a Global IP health check
- Retrieve a Global IP health check
- Global IP Latency Metrics
- List all Global IP Protocols
- Global IP Usage Metrics
- List all Global IPs
- Create a Global IP
- Delete a Global IP
- Retrieve a Global IP
- Integration Secrets
- Inventory Level
- IP Connections
- IPs
- Reports
- Managed Accounts
- Lists accounts managed by the current user.
- Create a new managed account.
- Display information about allocatable global outbound channels for the current user.
- Retrieve a managed account
- Update a managed account
- Disables a managed account
- Enables a managed account
- Update the amount of allocatable global outbound channels allocated to a specific managed account.
- Media Storage API
- Messages
- Messaging Hosted Number
- List messaging hosted number orders
- Create a messaging hosted number order
- Check eligibility of phone numbers for hosted messaging
- Retrieve a messaging hosted number order
- Upload file required for a messaging hosted number order
- Validate the verification codes for the hosted numbers order
- Create verification codes for the hosted numbers order
- Delete a messaging hosted number
- Number Configurations
- Advanced OptIn
- Messaging Profiles
- Messaging Tollfree Verification
- Messaging URL Domains
- RCS messaging
- Mobile Network Operators
- Push Credentials
- Coverage
- Networks
- Notifications
- List notification channels
- Create a notification channel
- Delete a notification channel
- Get a notification channel
- Update a notification channel
- List all Notifications Events Conditions
- List all Notifications Events
- List all Notifications Profiles
- Create a notification profile
- Delete a notification profile
- Get a notification profile
- Update a notification profile
- List notification settings
- Add a Notification Setting
- Delete a notification setting
- Get a notification setting
- Phone Number Block Orders
- Number Lookup
- Requirement Groups
- Update requirement group for a phone number order
- List requirement groups
- Create a new requirement group
- Delete a requirement group by ID
- Get a single requirement group by ID
- Update requirement values in requirement group
- Submit a Requirement Group for Approval
- Update requirement group for a sub number order
- Phone Number Reservations
- numbers features
- OTA updates
- Outbound Voice Profiles
- Shared Campaigns
- AutoRechargePreferences
- Bulk Phone Number Campaigns
- Phone Number Blocks Background Jobs
- Phone Number Campaigns
- Phone Number Configurations
- List phone numbers
- Slim List phone numbers
- List phone numbers with voice settings
- Delete a phone number
- Retrieve a phone number
- Update a phone number
- Change the bundle status for a phone number (set to being in a bundle or remove from a bundle)
- Enable emergency for a phone number
- Retrieve a phone number with voice settings
- Update a phone number with voice settings
- CSV Downloads
- Bulk Phone Number Operations
- Voicemail
- Regulatory Requirements
- Phone Number Porting
- Porting Orders
- List all porting events
- Show a porting event
- Republish a porting event
- Preview the LOA configuration parameters
- List LOA configurations
- Create a LOA configuration
- Delete a LOA configuration
- Retrieve a LOA configuration
- Update a LOA configuration
- Preview a LOA configuration
- List porting related reports
- Create a porting related report
- Retrieve a report
- List all porting orders
- Create a porting order
- List all exception types
- List all phone number configurations
- Create a list of phone number configurations
- Delete a porting order
- Retrieve a porting order
- Edit a porting order
- Activate every number in a porting order asynchronously.
- Cancel a porting order
- Submit a porting order.
- Share a porting order
- List all porting activation jobs
- Retrieve a porting activation job
- Update a porting activation job
- List additional documents
- Create a list of additional documents
- Delete an additional document
- List allowed FOC dates
- List all comments of a porting order
- Create a comment for a porting order
- Download a porting order loa template
- List porting order requirements
- Retrieve the associated V1 sub_request_id and port_request_id
- List verification codes
- Send the verification codes
- Verify the verification code for a list of phone numbers
- List all phone number blocks
- Create a phone number block
- Delete a phone number block
- List all phone number extensions
- Create a phone number extension
- Delete a phone number extension
- List all porting phone numbers
- Number Portout
- List portout requests
- List all port-out events
- Show a port-out event
- Republish a port-out event
- List eligible port-out rejection codes for a specific order
- List port-out related reports
- Create a port-out related report
- Retrieve a report
- Get a portout request
- List all comments for a portout request
- Create a comment on a portout request
- List supporting documents on a portout request
- Create a list of supporting documents on a portout request
- Update Status
- Private Wireless Gateways
- Public Internet Gateways
- Queue Commands
- Regions
- CDR Usage Reports
- MDR Usage Reports
- MDR Detail Reports
- WDR Detail Reports
- Requirement Types
- Requirements
- Room Compositions
- Room Participants
- Room Recordings
- Room Sessions
- Rooms
- Rooms Client Tokens
- Short Codes
- SIM Card Group Actions
- SIM Card Groups
- SIM Card Orders
- SIPREC Connectors
- Bucket SSL Certificate
- Bucket Usage
- Presigned Object URLs
- Data Migration
- Credentials
- Access Tokens
- TeXML REST Commands
- Fetch multiple call resources
- Initiate an outbound call
- Fetch a call
- Update call
- Fetch recordings for a call
- Request recording for a call
- Update recording on a call
- Request siprec session for a call
- Updates siprec session for a call
- Start streaming media from a call.
- Update streaming on a call
- List conference resources
- Fetch a conference resource
- Update a conference resource
- List conference participants
- Dial a new conference participant
- Delete a conference participant
- Get conference participant resource
- Update a conference participant
- List conference recordings
- Fetch recordings for a conference
- Fetch multiple recording resources
- Delete recording resource
- Fetch recording resource
- List recording transcriptions
- Delete a recording transcription
- Fetch a recording transcription resource
- (Deprecated) Initiate an outbound call
- (Deprecated) Update call
- Create a TeXML secret
- TeXML Applications
- Text to Speech Commands
- Usage Reports (BETA)
- UserAddresses
- User Tags
- Verify
- List verifications by phone number
- Verify verification code by phone number
- Trigger Call verification
- Trigger Flash call verification
- Trigger SMS verification
- Retrieve verification
- Verify verification code by ID
- List all Verify profiles
- Create a Verify profile
- Retrieve Verify profile message templates
- Delete Verify profile
- Retrieve Verify profile
- Update Verify profile
- Verified Numbers
- Virtual Cross Connects
- Webhooks
- WireGuard Interfaces
- Reporting
- Wireless Regions
- Object
Create a chat completion
POST
/ai/chat/completions
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/ai/chat/completions' \
--header 'Content-Type: application/json' \
--data-raw '{
"messages": [
{
"content": "You are a friendly chatbot.",
"role": "system"
},
{
"content": "Hello, world!",
"role": "user"
}
]
}'Response Response Example
200 - Example 1
nullRequest
Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************Body Params application/json
Examples
Responses
🟢200OK
application/json
Body
🟠422Parameter Error
Modified at 2025-06-16 19:14:41