Skip to contentSkip to navigationSkip to topbar
Twilio Docs

Retrieve 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.

GET/v2/ControlPlane/KnowledgeBases/{kbId}

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

Retrieve the details of a specific Knowledge Base by its unique ID.

Request

fetch-knowledge-base-request page anchor

Authentication

authentication page anchor

Path parameters

fetch-knowledge-base-path-parameters page anchor
Property nameTypeRequiredPIIDescription
kbIdstring
required
Not PII

A unique Knowledge Base ID using Twilio Type ID (TTID) format

Example: know_knowledgebase_00000000000000000000000000Pattern: ^know_knowledgebase_[0-7][0-9a-z]{25}$

Responses

fetch-knowledge-base-responses page anchor
200400404429500503

Knowledge Base details retrieved successfully

Schema
Property nameTypeRequiredPIIDescriptionChild properties
displayNamestring

Optional

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
idstring

Optional

Not PII

The unique identifier for the Knowledge Base

Example: know_knowledgebase_00000000000000000000000000Pattern: ^know_knowledgebase_[0-7][0-9a-z]{25}$
statusenum<string>

Optional

Not PII

The provisioning status of the Knowledge Base

Example: ACTIVEPossible values:
QUEUEDPROVISIONINGACTIVEFAILEDDELETING
createdAtstring<date-time>

Optional

Not PII

The ISO 8601 timestamp when the Knowledge Base was created.

Example: 2024-01-15T10:30:00Z
updatedAtstring<date-time>

Optional

Not PII

The ISO 8601 timestamp when the Knowledge Base was last updated.

Example: 2024-01-15T11:45:00Z
versioninteger

Optional

Not PII

The current version number of the Knowledge Base. Incremented on each successful mutable update.

Example: 3Minimum: 1
Retrieve a Knowledge BaseLink to code sample: Retrieve 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 fetchKnowledgeBase() {

11
  const knowledgeBasis = await client.knowledge.v2

12
    .knowledgeBases("know_knowledgebase_00000000000000000000000000")

13
    .fetch();

14


15
  console.log(knowledgeBasis.displayName);

16
}

17


18
fetchKnowledgeBase();

Response

Note about this response
1
{

2
  "createdAt": "2009-07-06T20:30:00Z",

3
  "description": "description",

4
  "displayName": "product-docs",

5
  "id": "know_knowledgebase_00000000000000000000000000",

6
  "status": "ACTIVE",

7
  "updatedAt": "2009-07-06T20:30:00Z",

8
  "version": 3

9
}