Twilio Knowledge API
APIs for managing knowledge bases and knowledge content for AI-powered applications.
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
APIs for managing knowledge bases and knowledge content for AI-powered applications.
Endpoints 13
Operations
- GETGet Operation Status
/v2/ControlPlane/Operations/:operationIdRetrieve the status and result of an asynchronous operation.
Knowledge
- GETList Knowledge Sources
/v2/KnowledgeBases/:kbId/Knowledge?page=0&pageSize=50&pageToken=stringRetrieve a paginated list of all knowledge sources for a specific knowledge base. Knowledge sources represent unstructured data sources such as documents,… - POSTCreate Knowledge Source
/v2/KnowledgeBases/:kbId/KnowledgeCreate a new knowledge source from various data sources such as web content, files, or raw text. The knowledge source will be processed and indexed to enable… - POSTSearch Knowledge Chunks
/v2/KnowledgeBases/:kbId/SearchPerform semantic search across knowledge sources within a knowledge base to find the most relevant content chunks based on a natural language query. Returns… - GETRetrieve Knowledge Source
/v2/KnowledgeBases/:kbId/Knowledge/:knowledgeIdFetch detailed information about a specific knowledge source by its ID. This returns the complete knowledge source object including processing status, source… - DELETEDelete Knowledge Source
/v2/KnowledgeBases/:kbId/Knowledge/:knowledgeIdPermanently delete knowledge source and all its associated data, including processed chunks and embeddings. This action cannot be undone. The knowledge… - PATCHUpdate Knowledge Source
/v2/KnowledgeBases/:kbId/Knowledge/:knowledgeId?refresh=falsePartially update mutable fields of an existing knowledge source such as name, description, tags, or source-specific configuration. Only the fields provided in… - GETList Knowledge Chunks
/v2/KnowledgeBases/:kbId/Knowledge/:knowledgeId/Chunks?pageSize=1&pageToken=stringRetrieve a paginated list of all processed content chunks from a specific knowledge source. Chunks are smaller segments of content that have been extracted…
KnowledgeBases
- GETList Knowledge Bases
/v2/ControlPlane/KnowledgeBases?pageSize=50&pageToken=string&orderBy=DESCGet a list of knowledge bases for the Twilio account. - POSTCreate a Knowledge Base
/v2/ControlPlane/KnowledgeBasesCreate a new Knowledge Base for the Twilio account. Accounts can have multiple knowledge bases. Each knowledge base can contain multiple knowledge resources… - GETRetrieve a Knowledge Base
/v2/ControlPlane/KnowledgeBases/:kbIdRetrieve the details of a specific Knowledge Base by its unique ID. - DELETEDelete a Knowledge Base
/v2/ControlPlane/KnowledgeBases/:kbIdDelete a Knowledge Base and all associated knowledge resources. This action cannot be undone. - PATCHUpdate a Knowledge Base
/v2/ControlPlane/KnowledgeBases/:kbIdPartially update a Knowledge Base. Only the fields provided in the request body will be updated.
API details
- Base URL
https://knowledge.twilio.com- Authentication
- HTTP Basic authentication (username and password)
- Operations
- 13 operations on 7 pathsGET 6POST 3PATCH 2DELETE 2
- Main resources
- Knowledge 7KnowledgeBases 5Operations 1
- Response formats
application/json- Description format
- OpenAPI 3.0.1, API version
1.0 - Links
- OpenAPI document · Terms of service · Support
- Listed from
- Twilio's published OpenAPI description (twilio/twilio-oai) (MIT)
How to test the Twilio Knowledge 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 Knowledge 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 “Get Operation Status” (GET /v2/ControlPlane/Operations/:operationId), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Twilio Knowledge API?
APIs for managing knowledge bases and knowledge content for AI-powered applications. It is listed under Communication and has 13 endpoints.
Who publishes the Twilio Knowledge 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 Knowledge API?
Requests go to https://knowledge.twilio.com. Endpoint paths are added to this base URL.
How do I authenticate with the Twilio Knowledge API?
With HTTP Basic authentication (username and password).
How many endpoints does the Twilio Knowledge API have?
13 operations on 7 paths (6 GET, 3 POST, 2 PATCH, 2 DELETE). The largest groups are Knowledge, KnowledgeBases, Operations.
Is forking the Twilio Knowledge API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.