Twilio Conversational Intelligence API
The Conversational Intelligence API includes resources to create and manage intelligence configurations, define and run language operators, and retrieve…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The Conversational Intelligence API includes resources to create and manage intelligence configurations, define and run language operators, and retrieve processed conversations and operator results.
- Use the Configurations resource to create and manage intelligence configurations and define rules that control how and when language operators analyze and transform conversations.
- Use the Operators resource to create custom language operators or retrieve Twilio-author and custom operators.
- Use the Conversations resource to retrieve conversations processed with an intelligence configuration, and the OperatorResults resource to retrieve language operator results for those conversations.
Endpoints 18
Configurations
- GETRetrieve a list of Intelligence Configurations
/v3/ControlPlane/Configurations?pageSize=50&pageToken=string - POSTCreate an Intelligence Configuration
/v3/ControlPlane/ConfigurationsCreate an Intelligence Configuration to control how and when language operators analyze conversations. You must include the rules field in the request. You… - GETRetrieve an Intelligence Configuration
/v3/ControlPlane/Configurations/:id - PUTUpdate an Intelligence Configuration
/v3/ControlPlane/Configurations/:idUpdate an Intelligence Configuration, including its metadata and rules. The request must include all required fields. - DELETEDelete an Intelligence Configuration
/v3/ControlPlane/Configurations/:id
Operators
- GETRetrieve a list of Operators
/v3/ControlPlane/Operators?pageSize=50&pageToken=stringRetrieve a list of Operators for the account, including those not attached to an Intelligence Configuration. This request returns both Twilio-authored and… - POSTCreate an Operator
/v3/ControlPlane/OperatorsCreate a custom language operator. You can define a reusable, programmable conversational analysis task tailored to your business needs. - GETRetrieve an Operator
/v3/ControlPlane/Operators/:id - PUTUpdate an Operator
/v3/ControlPlane/Operators/:id - DELETEDelete an Operator
/v3/ControlPlane/Operators/:id - GETRetrieve a list of Operator Versions
/v3/ControlPlane/Operators/:id/Versions?pageSize=50&pageToken=stringRetrieve a paginated list of all versions for a given Language Operator. - GETRetrieve a specific Operator Version
/v3/ControlPlane/Operators/:id/Versions/:version
OperatorResults
- GETRetrieve a list of OperatorResults
/v3/OperatorResults?conversationId=conv_conversation_01k1etk2y5f1y9fpe2epfdtvv2&intelligenceConfigurationId=intelligence_configuration_01k6fc25s7epm9qtk8rszbv3q5&operatorId=intelligence_operator_01k6fc25s7epm9qtk8rszbv3q5&pageSize=50&pageToken=string - GETRetrieve an OperatorResult
/v3/OperatorResults/:operatorResultId - DELETEDelete an OperatorResult
/v3/OperatorResults/:operatorResultId
Conversations
- GETRetrieve a list of Conversations
/v3/Conversations?pageSize=50&pageToken=string&createdAtBefore=2024-01-01T00:00:00Z&createdAtAfter=2024-01-01T00:00:00Z&status=ACTIVE&channelId=string&channels=VOICE&conversationConfigurationId=conv_configuration_00000000000000000000000000&intelligenceConfigurationIds=intelligence_configuration_01k6fc25s7epm9qtk8rszbv3q5&operatorIds=intelligence_operator_01k6fc25s7epm9qtk8rszbv3q5Retrieve a list of Conversations processed by an Intelligence Configuration. - GETRetrieve a Conversation
/v3/Conversations/:id
RuleExecutions
- POSTOn-demand Rule execution
/v3/RuleExecutionsResolves the given configuration, rule, and conversation, derives the memoryStoreId from the conversation's configuration. Then executes the rule on the…
API details
- Base URL
https://intelligence.twilio.com- Authentication
- HTTP Basic authentication (username and password)
- Operations
- 18 operations on 11 pathsGET 10POST 3DELETE 3PUT 2
- Main resources
- Operators 7Configurations 5OperatorResults 3Conversations 2RuleExecutions 1
- Response formats
application/json- Description format
- OpenAPI 3.0.1, API version
v3 - Links
- OpenAPI document · Terms of service · Support
- Listed from
- Twilio's published OpenAPI description (twilio/twilio-oai) (MIT)
How to test the Twilio Conversational Intelligence API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Twilio Conversational Intelligence API collection, without the publisher's secrets.
- Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Retrieve a list of Intelligence Configurations” (GET /v3/ControlPlane/Configurations?pageSize=50&pageToken=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Twilio Conversational Intelligence API?
The Conversational Intelligence API includes resources to create and manage intelligence configurations, define and run language operators, and retrieve… It is listed under Communication and has 18 endpoints.
Who publishes the Twilio Conversational Intelligence API?
It is listed from Twilio's public API description (an OpenAPI document), not published by Twilio on Swastik Codes. Anyone who controls twilio.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Twilio Conversational Intelligence API?
Requests go to https://intelligence.twilio.com. Endpoint paths are added to this base URL.
How do I authenticate with the Twilio Conversational Intelligence API?
With HTTP Basic authentication (username and password).
How many endpoints does the Twilio Conversational Intelligence API have?
18 operations on 11 paths (10 GET, 3 POST, 3 DELETE, 2 PUT). The largest groups are Operators, Configurations, OperatorResults, Conversations.
Is forking the Twilio Conversational Intelligence API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.