Search knowledge base | ElevenLabs Documentation

curl -G https://api.elevenlabs.io/v1/convai/knowledge-base/search \
     -H "Content-Type: application/json" \
     -d query=query \
     -d page_size=1 \
     -d types=file \
     -d cursor=cursor

{
  "results": [
    {
      "document": {
        "type": "file",
        "access_info": {
          "is_creator": true,
          "creator_name": "John Doe",
          "creator_email": "john.doe@example.com",
          "role": "admin",
          "access_source": "creator"
        },
        "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
        "metadata": {
          "created_at_unix_secs": 1685600000,
          "last_updated_at_unix_secs": 1688200000,
          "size_bytes": 2457600
        },
        "name": "Product User Guide.pdf",
        "supported_usages": [
          "prompt"
        ],
        "dependent_agents": [
          {
            "type": "available",
            "access_level": "admin",
            "created_at_unix_secs": 1672500000,
            "id": "agent-1234",
            "name": "Support Bot"
          }
        ]
      },
      "score": 0.95,
      "search_snippet": [
        {
          "value": "The installation process requires a minimum of 4GB RAM and 500MB free disk space.",
          "is_hit": true
        }
      ]
    }
  ],
  "next_cursor": "eyJwYWdlIjoxfQ=="
}

Fuzzy text search over knowledge base document content

Query parameters

querystringRequired

The search query text

page_sizeintegerOptional1-100Defaults to 30

How many documents to return at maximum. Can not exceed 100, defaults to 30.

typesenumOptional

If present, the endpoint will return only documents of the given types.

Allowed values:

cursorstringOptional

Used for fetching next page. Cursor is returned in the response.

Response

Successful Response

resultslist of objects

next_cursorstring

Errors

422

Knowledge Base Search Request Unprocessable Entity Error

Headers

Query parameters

Response

Errors