Get knowledge base document

GET

/v1/convai/knowledge-base/:documentation_id

GET

/v1/convai/knowledge-base/:documentation_id

1 import { ElevenLabsClient } from "@elevenlabs/elevenlabs-js";
2 
3 async function main() {
4     const client = new ElevenLabsClient({
5         environment: "https://api.elevenlabs.io",
6     });
7     await client.conversationalAi.knowledgeBase.documents.get("21m00Tcm4TlvDq8ikWAM", {
8         agentId: "agent_id",
9     });
10 }
11 main();

Try it

1 {
2   "type": "url",
3   "access_info": {
4     "is_creator": true,
5     "creator_name": "John Doe",
6     "creator_email": "john.doe@example.com",
7     "role": "admin"
8   },
9   "extracted_inner_html": "extracted_inner_html",
10   "id": "id",
11   "metadata": {
12     "created_at_unix_secs": 1,
13     "last_updated_at_unix_secs": 1,
14     "size_bytes": 1
15   },
16   "name": "name",
17   "supported_usages": [
18     "prompt"
19   ],
20   "url": "url",
21   "folder_parent_id": "folder_parent_id",
22   "folder_path": [
23     {
24       "id": "id",
25       "name": "name"
26     }
27   ]
28 }

Get details about a specific documentation making up the agent's knowledge base

Path parameters

documentation_idstringRequired

The id of a document from the knowledge base. This is returned on document addition.

Query parameters

agent_idstringOptionalDefaults to

Response

Successful Response

urlobject

fileobject

textobject

folderobject

Get knowledge base document

Path parameters

Headers

Query parameters

Response

Errors