apicheats.dev elevenlabs/llms.txt Raw .md
GET

/v1/convai/knowledge-base

ElevenLabs API

Get Knowledge Base List

Base URL
https://api.elevenlabs.io
Auth
xi-api-key: <ELEVENLABS_API_KEY>
Last verified
2026-09-03 · upstream hash matched
Actions
Agents: curl -H "Accept: text/markdown" this URL
→ 207 tokens · Vary: Accept

Critical gotchas

Authentication uses the non-standard xi-api-key header, not Authorization: Bearer. Sending a Bearer token returns HTTP 401.

Text-to-speech responses are raw binary audio, not JSON. Write the body to a file (--output speech.mp3) rather than parsing it.

cURL

curl -X GET 'https://api.elevenlabs.io/v1/convai/knowledge-base?page_size=30&search=example-search&show_only_owned_documents=false&created_by_user_id=created-by-user-id&types=example&parent_folder_id=parent-folder-id&ancestor_folder_id=ancestor-folder-id&folders_first=false&sort_direction=asc&sort_by=name&cursor=example-cursor' \  -H "xi-api-key: $ELEVENLABS_API_KEY"
Get a free ElevenLabs API key → sponsored

Parameters

Name In Type Required Description
page_size query integer No How many documents to return at maximum. Can not exceed 100, defaults to 30.
search query string No If specified, the endpoint returns only such knowledge base documents whose names start with this string.
show_only_owned_documents query boolean No If set to true, the endpoint will return only documents owned by you (and not shared from somebody else). Deprecated: use created_by_user_id instead.
created_by_user_id query string No Filter documents by creator user ID. When set, only documents created by this user are returned. Takes precedence over show_only_owned_documents. Use '@me' to refer to the authenticated user.
types query string[] No If present, the endpoint will return only documents of the given types.
parent_folder_id query string No If set, the endpoint will return only documents that are direct children of the given folder.
ancestor_folder_id query string No If set, the endpoint will return only documents that are descendants of the given folder.
folders_first query boolean No Whether folders should be returned first in the list of documents.
sort_direction query string No The direction to sort the results
sort_by query string No The field to sort the results by
cursor query string No Used for fetching next page. Cursor is returned in the response.

Response 200 OK

{
  "documents": [
    {
      "id": "string",
      "name": "string",
      "metadata": {
        "created_at_unix_secs": 0,
        "last_updated_at_unix_secs": 0,
        "size_bytes": 0
      },
      "supported_usages": [
        "auto"
      ],
      "access_info": {
        "access_source": "creator",
        "creator_email": "john.doe@example.com",
        "creator_name": "John Doe",
        "is_creator": true,
        "role": "admin"
      },
      "folder_parent_id": "string",
      "folder_path": [
        {
          "id": "string"
        }
      ],
      "dependent_agents": [
        {
          "referenced_resource_ids": [
            "[recursive or deeply nested schema]"
          ],
          "id": "string",
          "name": "string",
          "type": "available",
          "created_at_unix_secs": 0,
          "access_level": "admin"
        }
      ],
      "type": "string",
      "url": "string",
      "auto_sync_info": {
        "minimum_frequency_days": 7,
        "auto_remove": false,
        "consec_failures": 0,
        "next_refresh_by": 0
      }
    }
  ],
  "next_cursor": "string",
  "has_more": true
}