> This is a page from the ElevenLabs documentation. For a complete page index, fetch https://elevenlabs.io/docs/llms.txt. For the full documentation in a single file, fetch https://elevenlabs.io/docs/llms-full.txt.

# Kennisbanklijst ophalen

GET https://api.elevenlabs.io/v1/convai/knowledge-base

Haal een lijst op van beschikbare kennisbankdocumenten

Reference: https://elevenlabs.io/docs/api-reference/knowledge-base/list

## Servers

- `https://api.elevenlabs.io` (Production, default)
- `https://api.us.elevenlabs.io` (Production US)
- `https://api.eu.residency.elevenlabs.io` (Production EU)
- `https://api.in.residency.elevenlabs.io` (Production India)
- `https://api.sg.residency.elevenlabs.io` (Production Singapore)

## Request

### Query parameters

- `page_size` (integer, optional, default: 30) — Het maximale aantal documenten dat moet worden geretourneerd. Mag niet meer zijn dan 100; standaard is dit 30.
- `search` (string, optional, nullable) — Als dit wordt opgegeven, retourneert het endpoint alleen kennisbankdocumenten waarvan de naam met deze string begint.
- `show_only_owned_documents` (boolean, optional, default: false, deprecated) — Als dit is ingesteld op true, retourneert het endpoint alleen documenten waarvan jij de eigenaar bent, en niet documenten die iemand anders heeft gedeeld. Verouderd: gebruik in plaats daarvan created_by_user_id.
- `created_by_user_id` (string, optional, nullable) — Filter documenten op gebruikers-ID van de maker. Wanneer ingesteld, worden alleen documenten geretourneerd die door deze gebruiker zijn gemaakt. Dit heeft voorrang op show_only_owned_documents. Gebruik '@me' om te verwijzen naar de geverifieerde gebruiker.
- `types` (list of enum, optional, nullable) — Als dit aanwezig is, retourneert het endpoint alleen documenten van de opgegeven typen.
  - Allowed values: `file`, `url`, `text`, `folder`
- `parent_folder_id` (string, optional, nullable) — Als dit is ingesteld, retourneert het endpoint alleen documenten die direct onder de opgegeven map vallen.
- `ancestor_folder_id` (string, optional, nullable) — Als dit is ingesteld, retourneert het endpoint alleen documenten die onder de opgegeven map vallen.
- `folders_first` (boolean, optional, default: false) — Of mappen als eerste moeten worden geretourneerd in de lijst met documenten.
- `sort_direction` (enum, optional) — De richting waarin je de resultaten sorteert
  - Allowed values: `asc`, `desc`
- `sort_by` (enum, optional, nullable) — Het veld waarop de resultaten worden gesorteerd
  - Allowed values: `name`, `created_at`, `updated_at`, `size`
- `cursor` (string, optional, nullable) — Gebruikt om de volgende pagina op te halen. De cursor wordt teruggegeven in de response.

## Response

### 200

Geslaagde response

- `documents` (list of GetKnowledgeBaseListResponseModelDocumentsItems, required)
- `has_more` (boolean, required)
- `next_cursor` (string, optional, nullable)

## Errors

### 422 Unprocessable Entity Error

Validatiefout

- `detail` (list of ValidationError, optional)

## Types

### GetKnowledgeBaseListResponseModelDocumentsItems

- `type`: `file` (GetKnowledgeBaseSummaryFileResponseModel)
  - `access_info` (ResourceAccessInfo, required)
  - `id` (string, required)
  - `metadata` (KnowledgeBaseDocumentMetadataResponseModel, required)
  - `name` (string, required)
  - `supported_usages` (list of enum, required)
    - Allowed values: `prompt`, `auto`
  - `dependent_agents` (list of V1ConvaiKnowledgeBaseSummariesGetResponsesContentApplicationJsonSchemaDiscriminatorMappingSuccessDataDiscriminatorMappingFileDependentAgentsItems, required, deprecated) — Dit veld is verouderd en wordt in de toekomst verwijderd. Gebruik in plaats daarvan het aparte endpoint om afhankelijke agents op te halen.
  - `auto_sync_info` (AutoSyncInfo, optional, nullable)
  - `external_sync_info` (ExternalFileSyncInfo, optional, nullable) — Houdt de link naar het oorspronkelijke bestand in een externe bron bij.
  - `folder_parent_id` (string, optional, nullable) — De ID van de bovenliggende map, of null als het document zich op hoofdniveau bevindt.
  - `folder_path` (list of KnowledgeBaseFolderPathSegmentSummaryResponseModel, optional) — De segmenten van het mappad naar deze entiteit, van de hoofdmap naar de bovenliggende map.
  - `is_frozen` (boolean, optional, default: false)
  - `refresh_status` (FileRefreshStatus, optional, nullable) — Status van een lopende/laatste vernieuwing voor een extern gesynchroniseerd KB-bestand.
- `type`: `folder` (GetKnowledgeBaseSummaryFolderResponseModel)
  - `access_info` (ResourceAccessInfo, required)
  - `children_count` (integer, required)
  - `document_count` (integer, required) — Aantal documenten die geen map zijn, overal in de substructuur van deze map (recursief). Het tellen stopt boven 1000;
  - `id` (string, required)
  - `metadata` (KnowledgeBaseDocumentMetadataResponseModel, required)
  - `name` (string, required)
  - `supported_usages` (list of enum, required)
    - Allowed values: `prompt`, `auto`
  - `dependent_agents` (list of V1ConvaiKnowledgeBaseSummariesGetResponsesContentApplicationJsonSchemaDiscriminatorMappingSuccessDataDiscriminatorMappingFolderDependentAgentsItems, required, deprecated) — Dit veld is verouderd en wordt in de toekomst verwijderd. Gebruik in plaats daarvan het aparte endpoint om afhankelijke agents op te halen.
  - `auto_sync_info` (AutoSyncInfo, optional, nullable)
  - `external_sync_info` (ExternalFolderSyncInfo, optional, nullable) — Metadata voor een KB-map die een externe bronmap weerspiegelt.
  - `folder_parent_id` (string, optional, nullable) — De ID van de bovenliggende map, of null als het document zich op hoofdniveau bevindt.
  - `folder_path` (list of KnowledgeBaseFolderPathSegmentSummaryResponseModel, optional) — De segmenten van het mappad naar deze entiteit, van de hoofdmap naar de bovenliggende map.
  - `is_frozen` (boolean, optional, default: false)
- `type`: `text` (GetKnowledgeBaseSummaryTextResponseModel)
  - `access_info` (ResourceAccessInfo, required)
  - `id` (string, required)
  - `metadata` (KnowledgeBaseDocumentMetadataResponseModel, required)
  - `name` (string, required)
  - `supported_usages` (list of enum, required)
    - Allowed values: `prompt`, `auto`
  - `dependent_agents` (list of V1ConvaiKnowledgeBaseSummariesGetResponsesContentApplicationJsonSchemaDiscriminatorMappingSuccessDataDiscriminatorMappingTextDependentAgentsItems, required, deprecated) — Dit veld is verouderd en wordt in de toekomst verwijderd. Gebruik in plaats daarvan het aparte endpoint om afhankelijke agents op te halen.
  - `folder_parent_id` (string, optional, nullable) — De ID van de bovenliggende map, of null als het document zich op hoofdniveau bevindt.
  - `folder_path` (list of KnowledgeBaseFolderPathSegmentSummaryResponseModel, optional) — De segmenten van het mappad naar deze entiteit, van de hoofdmap naar de bovenliggende map.
- `type`: `url` (GetKnowledgeBaseSummaryURLResponseModel)
  - `access_info` (ResourceAccessInfo, required)
  - `id` (string, required)
  - `metadata` (KnowledgeBaseDocumentMetadataResponseModel, required)
  - `name` (string, required)
  - `supported_usages` (list of enum, required)
    - Allowed values: `prompt`, `auto`
  - `url` (string, required)
  - `dependent_agents` (list of V1ConvaiKnowledgeBaseSummariesGetResponsesContentApplicationJsonSchemaDiscriminatorMappingSuccessDataDiscriminatorMappingUrlDependentAgentsItems, required, deprecated) — Dit veld is verouderd en wordt in de toekomst verwijderd. Gebruik in plaats daarvan het aparte endpoint om afhankelijke agents op te halen.
  - `auto_sync_info` (AutoSyncInfo, optional, nullable)
  - `folder_parent_id` (string, optional, nullable) — De ID van de bovenliggende map, of null als het document zich op hoofdniveau bevindt.
  - `folder_path` (list of KnowledgeBaseFolderPathSegmentSummaryResponseModel, optional) — De segmenten van het mappad naar deze entiteit, van de hoofdmap naar de bovenliggende map.

### ValidationError

- `loc` (list of ValidationErrorLocItems, required)
- `msg` (string, required)
- `type` (string, required)

### ResourceAccessInfo

- `is_creator` (boolean, required) — Of de gebruiker die de request doet de maker van de agent is
- `creator_name` (string, required) — Naam van de maker van de agent
- `creator_email` (string, required) — E-mailadres van de maker van de agent
- `role` (enum, required) — De rol van de gebruiker die de request uitvoert
  - Allowed values: `admin`, `editor`, `commenter`, `viewer`
- `anonymous_access_level_override` (enum, optional, nullable) — Het toegangsniveau voor anonieme gebruikers. Als dit None is, wordt de resource niet openbaar gedeeld.
  - Allowed values: `admin`, `editor`, `commenter`, `viewer`
- `access_source` (enum, optional, nullable) — Waarom de aanvragende gebruiker toegang heeft tot deze resource. 'creator' = de aanroeper is de eigenaar. 'explicit' = de aanroeper (of een van diens workspacegroepen) staat in role_to_group_ids, naast de workspacebrede everyone-groep. 'workspace_default' = de workspacebrede everyone-groep staat in role_to_group_ids (elk niet-anoniem workspacelid, inclusief beheerders, ziet deze resource). 'workspace_admin' = de aanroeper is een workspacebeheerder en de beheerdersrol is de *enige* manier om toegang te krijgen; gereserveerd voor documenten die niemand anders kan zien. Hiermee kan de UI uitleggen waarom een kijker die beheerdersrechten omzeilt een document ziet dat niet expliciet met diegene is gedeeld.
  - Allowed values: `creator`, `explicit`, `workspace_admin`, `workspace_default`

### KnowledgeBaseDocumentMetadataResponseModel

- `created_at_unix_secs` (integer, required)
- `last_updated_at_unix_secs` (integer, required)
- `size_bytes` (integer, required)

### V1ConvaiKnowledgeBaseSummariesGetResponsesContentApplicationJsonSchemaDiscriminatorMappingSuccessDataDiscriminatorMappingFileDependentAgentsItems

- `type`: `available` (DependentAvailableAgentIdentifier)
  - `access_level` (enum, required)
    - Allowed values: `admin`, `editor`, `commenter`, `viewer`
  - `created_at_unix_secs` (integer, required)
  - `id` (string, required)
  - `name` (string, required)
  - `referenced_resource_ids` (list of string, optional) — Als de agent transitief afhankelijk is, bevat dit de ID's van de resources waarvan de agent rechtstreeks afhankelijk is.
- `type`: `unknown` (DependentUnknownAgentIdentifier)
  - `id` (string, required)
  - `referenced_resource_ids` (list of string, optional) — Als de agent transitief afhankelijk is, bevat dit de ID's van de resources waarvan de agent rechtstreeks afhankelijk is.

### AutoSyncInfo

- `minimum_frequency_days` (integer, optional, default: 7) — Minimale frequentie (in dagen) waarmee het document wordt vernieuwd. Het werkelijke interval kan korter zijn, maar nooit langer.
- `auto_remove` (boolean, optional, default: false) — Of het document moet worden verwijderd als de URL niet meer beschikbaar is
- `consec_failures` (integer, optional, default: 0) — Aantal opeenvolgende synchronisatiefouten
- `next_refresh_by` (integer, optional, nullable) — Unix-timestamp voor de volgende geplande synchronisatie of None (in het geval van mappen)
- `auto_discover` (boolean, optional, default: false, deprecated) — Verouderd. Dit veld heeft geen effect meer en wordt in een toekomstige release verwijderd.

### ExternalFileSyncInfo

Houdt de link naar het oorspronkelijke bestand in een externe bron bij.

- `type` (enum, required) — Provideridentificatie
  - Allowed values: `google_drive`
- `source_entity_id` (string, required) — Entity-ID in het externe systeem
- `integration_connection_id` (string, required) — Instance-ID van de integratieverbinding
- `source_parent_entity_id` (string, required) — Map-ID in het externe systeem waarvan dit bestand is gesynchroniseerd
- `source_mime_type` (string, required) — Oorspronkelijk MIME-type in het externe systeem
- `source_modified_time` (string, required) — Tijd van laatste wijziging uit het externe systeem
- `root_folder_id` (string, optional, nullable) — Map-ID van de KB-synchronisatieroot, gebruikt om alle entiteiten onder een synchronisatieboom op te vragen

### KnowledgeBaseFolderPathSegmentSummaryResponseModel

- `id` (string, required)

### FileRefreshStatus

Status van een lopende/laatste vernieuwing voor een extern gesynchroniseerd KB-bestand.

- `status` (enum, optional, default: queued)
  - Allowed values: `queued`, `processing`, `succeeded`, `failed`, `skipped`, `cancelled`
- `enqueued_at` (integer, optional, nullable)
- `started_at` (integer, optional, nullable)
- `completed_at` (integer, optional, nullable)
- `last_synced_at` (integer, optional, nullable)
- `error_message` (string, optional, nullable)

### V1ConvaiKnowledgeBaseSummariesGetResponsesContentApplicationJsonSchemaDiscriminatorMappingSuccessDataDiscriminatorMappingFolderDependentAgentsItems

- `type`: `available` (DependentAvailableAgentIdentifier)
  - `access_level` (enum, required)
    - Allowed values: `admin`, `editor`, `commenter`, `viewer`
  - `created_at_unix_secs` (integer, required)
  - `id` (string, required)
  - `name` (string, required)
  - `referenced_resource_ids` (list of string, optional) — Als de agent transitief afhankelijk is, bevat dit de ID's van de resources waarvan de agent rechtstreeks afhankelijk is.
- `type`: `unknown` (DependentUnknownAgentIdentifier)
  - `id` (string, required)
  - `referenced_resource_ids` (list of string, optional) — Als de agent transitief afhankelijk is, bevat dit de ID's van de resources waarvan de agent rechtstreeks afhankelijk is.

### ExternalFolderSyncInfo

Metadata voor een KB-map die een externe bronmap weerspiegelt.

- `type` (enum, required) — Provideridentificatie
  - Allowed values: `google_drive`
- `source_entity_id` (string, required) — Entity-ID in het externe systeem
- `integration_connection_id` (string, required) — Instance-ID van de integratieverbinding
- `root_folder_id` (string, optional, nullable) — Map-ID van de KB-synchronisatieroot. None betekent dat deze map de root is.
- `sync_cursor` (string, optional, nullable) — Ondoorzichtige cursor voor incrementele synchronisatie, geïnterpreteerd door de provider
- `last_sync_at` (integer, optional, nullable) — Unix-timestamp van de laatst voltooide synchronisatie

### V1ConvaiKnowledgeBaseSummariesGetResponsesContentApplicationJsonSchemaDiscriminatorMappingSuccessDataDiscriminatorMappingTextDependentAgentsItems

- `type`: `available` (DependentAvailableAgentIdentifier)
  - `access_level` (enum, required)
    - Allowed values: `admin`, `editor`, `commenter`, `viewer`
  - `created_at_unix_secs` (integer, required)
  - `id` (string, required)
  - `name` (string, required)
  - `referenced_resource_ids` (list of string, optional) — Als de agent transitief afhankelijk is, bevat dit de ID's van de resources waarvan de agent rechtstreeks afhankelijk is.
- `type`: `unknown` (DependentUnknownAgentIdentifier)
  - `id` (string, required)
  - `referenced_resource_ids` (list of string, optional) — Als de agent transitief afhankelijk is, bevat dit de ID's van de resources waarvan de agent rechtstreeks afhankelijk is.

### V1ConvaiKnowledgeBaseSummariesGetResponsesContentApplicationJsonSchemaDiscriminatorMappingSuccessDataDiscriminatorMappingUrlDependentAgentsItems

- `type`: `available` (DependentAvailableAgentIdentifier)
  - `access_level` (enum, required)
    - Allowed values: `admin`, `editor`, `commenter`, `viewer`
  - `created_at_unix_secs` (integer, required)
  - `id` (string, required)
  - `name` (string, required)
  - `referenced_resource_ids` (list of string, optional) — Als de agent transitief afhankelijk is, bevat dit de ID's van de resources waarvan de agent rechtstreeks afhankelijk is.
- `type`: `unknown` (DependentUnknownAgentIdentifier)
  - `id` (string, required)
  - `referenced_resource_ids` (list of string, optional) — Als de agent transitief afhankelijk is, bevat dit de ID's van de resources waarvan de agent rechtstreeks afhankelijk is.

### ValidationErrorLocItems

## Examples

**Response**

```json
{
  "documents": [
    {
      "access_info": {
        "access_source": "creator",
        "creator_email": "john.doe@example.com",
        "creator_name": "John Doe",
        "is_creator": true,
        "role": "admin"
      },
      "auto_sync_info": {
        "auto_discover": false,
        "auto_remove": false,
        "consec_failures": 0,
        "minimum_frequency_days": 7,
        "next_refresh_by": 1
      },
      "dependent_agents": [
        {
          "access_level": "admin",
          "created_at_unix_secs": 1,
          "id": "string",
          "name": "string",
          "referenced_resource_ids": [
            "string"
          ],
          "type": "available"
        }
      ],
      "folder_parent_id": "string",
      "folder_path": [
        {
          "id": "string"
        }
      ],
      "id": "string",
      "metadata": {
        "created_at_unix_secs": 1,
        "last_updated_at_unix_secs": 1,
        "size_bytes": 1
      },
      "name": "string",
      "supported_usages": [
        "auto"
      ],
      "type": "string",
      "url": "string"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
```

**SDK Code**

```python
import requests

url = "https://api.elevenlabs.io/v1/convai/knowledge-base"

response = requests.get(url)

print(response.json())
```

```javascript
const url = 'https://api.elevenlabs.io/v1/convai/knowledge-base';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.elevenlabs.io/v1/convai/knowledge-base"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.elevenlabs.io/v1/convai/knowledge-base")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.elevenlabs.io/v1/convai/knowledge-base")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.elevenlabs.io/v1/convai/knowledge-base');

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.elevenlabs.io/v1/convai/knowledge-base");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.elevenlabs.io/v1/convai/knowledge-base")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```