Skip to contentSkip to navigationSkip to topbar
Twilio Docs

List Knowledge Sources

(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/KnowledgeBases/{kbId}/Knowledge

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

Retrieve a paginated list of all knowledge sources for a specific knowledge base. Knowledge sources represent unstructured data sources such as documents, websites, or text content that can be used for context and information retrieval.

Request

list-knowledge-request page anchor

Authentication

authentication page anchor

Path parameters

list-knowledge-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}$

Query string

list-knowledge-query-string page anchor
Property nameTypeRequiredPIIDescription
pageinteger

Optional

Not PII

The page index. This value is simply for client state.

Minimum: 0
pageSizeinteger

Optional

Not PII

The maximum number of items to return per page, maximum of 1000.

Default: 50Minimum: 1Maximum: 1000
pageTokenstring

Optional

Not PII

The token for the page of results to retrieve.

Max length: 500

Responses

list-knowledge-responses page anchor
200400404429500503

OK

SchemaExample
Property nameTypeRequiredPIIDescriptionChild properties
knowledgearray[object]

Optional

Not PII
Max items: 1000
metaobject

Optional

Not PII

Pagination metadata for list operations

Example: {"key":"knowledge","pageSize":50,"nextToken":"eyJlYXN0ZXIiOiJlZ2cifQ","previousToken":""}
List Knowledge SourcesLink to code sample: List Knowledge Sources
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 listKnowledge() {

11
  const knowledge = await client.knowledge.v2

12
    .knowledge("know_knowledgebase_00000000000000000000000000")

13
    .list({ limit: 20 });

14


15
  knowledge.forEach((k) => console.log(k.name));

16
}

17


18
listKnowledge();

Response

Note about this response
1
{

2
  "knowledge": [

3
    {

4
      "name": "name",

5
      "description": "description",

6
      "source": {},

7
      "id": "know_knowledge_00000000000000000000000000",

8
      "status": "COMPLETED",

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

10
      "updatedAt": "2009-07-06T20:30:00Z"

11
    }

12
  ],

13
  "meta": {

14
    "key": "key",

15
    "pageSize": 50,

16
    "nextToken": "nextToken",

17
    "previousToken": "previousToken"

18
  }

19
}