Search knowledge base | ElevenLabs Documentation

{
  "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": "id",
        "metadata": {
          "created_at_unix_secs": 1,
          "last_updated_at_unix_secs": 1,
          "size_bytes": 1
        },
        "name": "name",
        "supported_usages": [
          "prompt"
        ],
        "dependent_agents": [
          {
            "type": "available",
            "access_level": "admin",
            "created_at_unix_secs": 1,
            "id": "id",
            "name": "name"
          }
        ]
      },
      "score": 1.1,
      "search_snippet": [
        {
          "value": "value",
          "is_hit": true
        }
      ]
    }
  ],
  "next_cursor": "next_cursor"
}

Fuzzy text search over knowledge base document content

Paramètres de requête

querystringRequis

The search query text

page_sizeintegerOptionnel1-100Par défaut 30

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

typesenumOptionnel

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

Valeurs autorisées:

cursorstringOptionnel

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

Réponse

Successful Response

resultslist of objects

next_cursorstringOptionnel

Erreurs

422

Knowledge Base Search Request Unprocessable Entity Error

En-têtes

Paramètres de requête

Réponse

Erreurs