Skip to contentSkip to navigationSkip to topbar
Twilio Docs

Create a Knowledge Base

(information)

Legal information

Enterprise Knowledge, including the APIs, may use artificial intelligence or machine learning technologies and is subject to the terms of the Predictive and Generative AI/ML Features Addendum(link takes you to an external page). For more details on AI usage and data, see the AI Nutrition Facts.

Enterprise Knowledge is not a HIPAA Eligible Service or PCI compliant and should not be enabled in workflows that are subject to HIPAA or PCI.

Conversations products are only available in the new Twilio Console(link takes you to an external page). If your account hasn't been migrated, you'll be redirected to the legacy Console where these products won't appear.

POST/v2/ControlPlane/KnowledgeBases

Base url: https://knowledge.twilio.com (base url)

Create a new Knowledge Base for the Twilio account. Accounts can have multiple knowledge bases. Each knowledge base can contain multiple knowledge resources such as documents, websites, or text content that can be used for context and information retrieval.

Request

create-knowledge-base-request page anchor

Authentication

authentication page anchor

Request body

create-knowledge-base-request-body page anchor
Encoding type:application/json
Schema
Property nameTypeRequiredPIIDescriptionChild properties
displayNamestring
required
Not PII

Provides a unique and addressable name to be assigned to this Knowledge Base. This name is assigned by the developer and can be used in addition to the ID. It is intended to be human-readable and unique within the account.

Example: product-docsPattern: ^[a-zA-Z0-9-]+$
descriptionstring

Optional

Not PII

A human readable description of this resource, up to 128 characters.

Example: Product documentation knowledge base for customer supportMin length: 1Max length: 128

Responses

create-knowledge-base-responses page anchor
202400404429500503

Knowledge Base creation request accepted.

Schema
Property nameTypeRequiredPIIDescriptionChild properties
messagestring

Optional

Not PII
Example: Knowledge Base creation request accepted for processing.Max length: 512
statusUrlstring

Optional

Not PII

URI to check operation status.

Max length: 512
Create a Knowledge BaseLink to code sample: Create a Knowledge Base
1
// Download the helper library from https://www.twilio.com/docs/node/install

2
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";

3


4
// Find your Account SID and Auth Token at twilio.com/console

5
// and set the environment variables. See http://twil.io/secure

6
const accountSid = process.env.TWILIO_ACCOUNT_SID;

7
const authToken = process.env.TWILIO_AUTH_TOKEN;

8
const client = twilio(accountSid, authToken);

9


10
async function createKnowledgeBase() {

11
  const knowledgeBasis = await client.knowledge.v2.knowledgeBases.create({

12
    displayName: "product-docs",

13
  });

14


15
  console.log(knowledgeBasis.message);

16
}

17


18
createKnowledgeBase();

Response

Note about this response
1
{

2
  "message": "message",

3
  "statusUrl": "statusUrl"

4
}