List knowledge base documents

1 curl https://api.elevenlabs.io/v1/convai/knowledge-base \ 2 -H "xi-api-key: <apiKey>"

1 { 2 "documents": [ 3 { 4 "type": "file", 5 "access_info": { 6 "is_creator": true, 7 "creator_name": "John Doe", 8 "creator_email": "john.doe@example.com", 9 "role": "admin" 10 }, 11 "dependent_agents": [ 12 { 13 "type": "available", 14 "access_level": "admin", 15 "created_at_unix_secs": 1, 16 "id": "id", 17 "name": "name" 18 } 19 ], 20 "id": "id", 21 "metadata": { 22 "created_at_unix_secs": 1, 23 "last_updated_at_unix_secs": 1, 24 "size_bytes": 1 25 }, 26 "name": "name", 27 "prompt_injectable": true 28 } 29 ], 30 "has_more": true, 31 "next_cursor": "next_cursor" 32 }

Get a list of available knowledge base documents

Query parameters

cursorstringOptional

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

page_sizeintegerOptional>=1<=100Defaults to 30

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

searchstringOptional

If specified, the endpoint returns only such knowledge base documents whose names start with this string.

show_only_owned_documentsbooleanOptionalDefaults to false

If set to true, the endpoint will return only documents owned by you (and not shared from somebody else).

typesenumOptional

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

Allowed values:

use_typesensebooleanOptionalDefaults to false

If set to true, the endpoint will use typesense DB to search for the documents).

Response

Successful Response

documentslist of objects

has_moreboolean

next_cursorstringOptional

Headers

Query parameters

Response

Errors