Search knowledge base | ElevenLabs Documentation

curl -G https://api.elevenlabs.io/v1/convai/knowledge-base/search \
     -d query=query

{
  "results": [
    {
      "document": {
        "id": "string",
        "name": "string",
        "metadata": {
          "created_at_unix_secs": 1,
          "last_updated_at_unix_secs": 1,
          "size_bytes": 1
        },
        "supported_usages": [
          "auto"
        ],
        "access_info": {
          "is_creator": true,
          "creator_name": "John Doe",
          "creator_email": "john.doe@example.com",
          "role": "admin"
        },
        "folder_parent_id": "string",
        "folder_path": [
          {
            "id": "string"
          }
        ],
        "dependent_agents": [
          {
            "referenced_resource_ids": [
              "string"
            ],
            "id": "string",
            "name": "string",
            "type": "available",
            "created_at_unix_secs": 1,
            "access_level": "admin"
          }
        ],
        "type": "string",
        "url": "string",
        "auto_sync_info": {
          "minimum_frequency_days": 7,
          "auto_remove": false,
          "consec_failures": 0,
          "next_refresh_by": 1
        }
      },
      "score": 1.1,
      "search_snippet": [
        {
          "value": "string",
          "is_hit": true
        }
      ]
    }
  ],
  "next_cursor": "string"
}

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.

typeslist of enums or nullOptional

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

Allowed values:

cursorstring or nullOptional

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

Response

Successful Response

resultslist of objects

next_cursorstring or null

Errors

422

Unprocessable Entity Error

Headers

Query parameters

Response

Errors