Get knowledge base summaries

from elevenlabs import ElevenLabs
from elevenlabs.environment import ElevenLabsEnvironment
client = ElevenLabs(
    environment=ElevenLabsEnvironment.PRODUCTION
)
client.conversational_ai.knowledge_base.documents.summaries.get()

{
  "string": {
    "status": "success",
    "data": {
      "type": "file",
      "access_info": {
        "is_creator": true,
        "creator_name": "creator_name",
        "creator_email": "creator_email",
        "role": "admin"
      },
      "id": "id",
      "metadata": {
        "created_at_unix_secs": 1,
        "last_updated_at_unix_secs": 1,
        "size_bytes": 1
      },
      "name": "name",
      "supported_usages": [
        "prompt",
        "prompt"
      ],
      "dependent_agents": [
        {
          "type": "available",
          "access_level": "admin",
          "created_at_unix_secs": 1,
          "id": "id",
          "name": "name",
          "referenced_resource_ids": [
            "referenced_resource_ids",
            "referenced_resource_ids"
          ]
        },
        {
          "type": "available",
          "access_level": "admin",
          "created_at_unix_secs": 1,
          "id": "id",
          "name": "name",
          "referenced_resource_ids": [
            "referenced_resource_ids",
            "referenced_resource_ids"
          ]
        }
      ],
      "folder_parent_id": "folder_parent_id",
      "folder_path": [
        {
          "id": "id"
        },
        {
          "id": "id"
        }
      ]
    }
  }
}

Gets multiple knowledge base document summaries by their IDs.

Query parameters

document_idsstringOptional

The ids of knowledge base documents.

Response

Successful Response

successobject

failureobject

1	{
2	"string": {
3	"status": "success",
4	"data": {
5	"type": "file",
6	"access_info": {
7	"is_creator": true,
8	"creator_name": "creator_name",
9	"creator_email": "creator_email",
10	"role": "admin"
11	},
12	"id": "id",
13	"metadata": {
14	"created_at_unix_secs": 1,
15	"last_updated_at_unix_secs": 1,
16	"size_bytes": 1
17	},
18	"name": "name",
19	"supported_usages": [
20	"prompt",
21	"prompt"
22	],
23	"dependent_agents": [
24	{
25	"type": "available",
26	"access_level": "admin",
27	"created_at_unix_secs": 1,
28	"id": "id",
29	"name": "name",
30	"referenced_resource_ids": [
31	"referenced_resource_ids",
32	"referenced_resource_ids"
33	]
34	},
35	{
36	"type": "available",
37	"access_level": "admin",
38	"created_at_unix_secs": 1,
39	"id": "id",
40	"name": "name",
41	"referenced_resource_ids": [
42	"referenced_resource_ids",
43	"referenced_resource_ids"
44	]
45	}
46	],
47	"folder_parent_id": "folder_parent_id",
48	"folder_path": [
49	{
50	"id": "id"
51	},
52	{
53	"id": "id"
54	}
55	]
56	}
57	}
58	}

Headers

Query parameters

Response

Errors