provider Agents Platform GET
/v1/convai/knowledge-base @utdk/elevenlabs
/v1/convai/knowledge-base Get Knowledge Base List
Get a list of available knowledge base documents
- page_size query
- How many documents to return at maximum. Can not exceed 100, defaults to 30.
- integer
- search query
- If specified, the endpoint returns only such knowledge base documents whose names start with this string.
- show_only_owned_documents query
- 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.
- boolean
- created_by_user_id query
- 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
- If present, the endpoint will return only documents of the given types.
- parent_folder_id query
- If set, the endpoint will return only documents that are direct children of the given folder.
- ancestor_folder_id query
- If set, the endpoint will return only documents that are descendants of the given folder.
- folders_first query
- Whether folders should be returned first in the list of documents.
- boolean
- sort_direction query
- The direction to sort the results
- enum: asc, desc
- sort_by query
- The field to sort the results by
- cursor query
- Used for fetching next page. Cursor is returned in the response.
- xi-api-key header
- Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.
Try it
Authentication
Configure credentials for ElevenLabs API Documentation
Code snippet
Updates live as you fill in the form above.
TypeScript
import elevenlabs from '@utdk/elevenlabs';
await elevenlabs.getKnowledgeBaseListRoute({
"page_size": 30,
"show_only_owned_documents": false,
"folders_first": false
})