v1

latestOpenAPI 3.0.1MIT2026-07-26104203277.0 KB

Return a list of Knowledge Base Items.

get/v1/voice-agents/knowledge-base/list

Query parameters

voiceAgentIdstring

Optional UUID of the voice agent to filter associated knowledge bases items.

Example:d949f13f-40d2-4e48-ac86-b66633070603

isActiveboolean

Optional boolean indicating whether to fetch active knowledge base items.

Example:true

usedstring

Optional boolean-like string indicating whether to fetch used knowledge base items in any voice agent.

Example:true

skipstring

Page number for pagination. Defaults to '1'.

Example:1

takestring

Number of items to take for pagination. Defaults to '10'.

Example:10

searchstring

A search query to filter knowledge base items' names.

Example:Product Catalog

typestring[]

An array of knowledge base item type to filter by.

[
  "TEXT",
  "URL"
]

statusstring[]

An array of knowledge base item status to filter by.

[
  "INGESTION_FAILURE",
  "PROCESSED"
]

extensionsstring[]

An array of knowledge base item extensions to filter by when the type is FILE.

[
  "pdf",
  "txt",
  "html"
]

sortField'words' | 'createdAt' | 'fileSize'

The field name to sort the results by

Example:createdAt

sortOrder'asc' | 'desc'

Sort order. Can be 'asc' or 'desc'.

Example:asc

Response

Successful response

successboolean

messagestring

Example response

{
  "data": {
    "total": 100,
    "filtered": 100,
    "items": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "userId": "550e8400-e29b-41d4-a716-446655440000",
        "projectId": "550e8400-e29b-41d4-a716-446655440000",
        "itemName": "Product Documentation",
        "fileSize": "2.5MB",
        "type": "TEXT",
        "status": "PROCESSED",
        "failureReason": "File format not supported",
        "content": "This is the content of the knowledge base item...",
        "itemUrl": "https://example.com/document.pdf",
        "itemUrls": [
          "https://example.com/document.pdf"
        ],
        "wordsNumber": 1298,
        "createdAt": "2024-01-15T10:30:00Z",
        "isActive": true,
        "used": true
      }
    ]
  }
}