List all knowledge for an Assistant

GET /v1/Assistants/{assistantId}/Knowledge

List all knowledge for an Assistant

Path parameters

  • assistantId string Required

    The assistant ID.

Query parameters

  • Page integer

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

    Minimum value is 0.

  • PageSize integer

    How many resources to return in each list page. The default is 50, and the maximum is 1000.

    Minimum value is 1, maximum value is 1000.

  • PageToken string

    The page token. This is provided by the API.

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • knowledge array[object]
      Hide knowledge attributes Show knowledge attributes object
      • description string

        The type of knowledge source.

      • id string Required

        The description of knowledge.

        Format should match the following pattern: ^aia_know_.+$.

      • account_sid string

        The SID of the Account that created the Knowledge resource.

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

      • knowledge_source_details object

        The details of the knowledge source based on the type.

      • name string Required

        The name of the knowledge source.

      • status string

        The status of processing the knowledge source ('QUEUED', 'PROCESSING', 'COMPLETED', 'FAILED')

      • type string Required

        The type of knowledge source ('Web', 'Database', 'Text', 'File')

      • url string

        The url of the knowledge resource.

      • embedding_model string

        The embedding model to be used for the knowledge source.

      • date_created string(date-time) Required

        The date and time in GMT when the Knowledge was created specified in ISO 8601 format.

      • date_updated string(date-time) Required

        The date and time in GMT when the Knowledge was last updated specified in ISO 8601 format.

    • meta object
      Hide meta attributes Show meta attributes object
      • first_page_url string(uri)
      • key string
      • next_page_url string(uri) | null
      • page integer
      • page_size integer
      • previous_page_url string(uri) | null
      • url string(uri)
GET /v1/Assistants/{assistantId}/Knowledge
curl \
 --request GET 'https://assistants.twilio.com/v1/Assistants/{assistantId}/Knowledge' \
 --user "username:password"
Response examples (200)
{
  "knowledge": [
    {
      "description": "string",
      "id": "string",
      "account_sid": "string",
      "knowledge_source_details": {},
      "name": "string",
      "status": "string",
      "type": "string",
      "url": "string",
      "embedding_model": "string",
      "date_created": "2025-05-04T09:42:00Z",
      "date_updated": "2025-05-04T09:42:00Z"
    }
  ],
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  }
}