> 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.

# Obter lista da base de conhecimento

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

Obtenha uma lista de documentos disponíveis na base de conhecimento

Reference: https://elevenlabs.io/docs/eleven-agents/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) — Quantidade máxima de documentos a retornar. Não pode exceder 100; o padrão é 30.
- `search` (string, optional) — Se especificado, o endpoint retorna somente documentos da base de conhecimento cujos nomes começam com esta string.
- `show_only_owned_documents` (boolean, optional, default: false, deprecated) — Se definido como true, o endpoint retornará apenas documentos que pertencem a você, e não compartilhados por outras pessoas. Obsoleto: use created_by_user_id.
- `created_by_user_id` (string, optional) — Filtre documentos pelo ID do usuário criador. Quando definido, retorna apenas documentos criados por esse usuário. Tem precedência sobre show_only_owned_documents. Use '@me' para se referir ao usuário autenticado.
- `types` (enum, optional) — Se presente, o endpoint retornará apenas documentos dos tipos informados.
  - Allowed values: `file`, `url`, `text`, `folder`
- `parent_folder_id` (string, optional) — Se definido, o endpoint retornará somente documentos que sejam filhos diretos da pasta informada.
- `ancestor_folder_id` (string, optional) — Se definido, o endpoint retornará somente documentos que sejam descendentes da pasta informada.
- `folders_first` (boolean, optional, default: false) — Se as pastas devem ser retornadas primeiro na lista de documentos.
- `sort_direction` (enum, optional) — A direção para ordenar os resultados
  - Allowed values: `asc`, `desc`
- `sort_by` (enum, optional) — O campo pelo qual ordenar os resultados
  - Allowed values: `name`, `created_at`, `updated_at`, `size`
- `cursor` (string, optional) — Usado para buscar a próxima página. O cursor é retornado na resposta.

## Response

### 200

Resposta bem-sucedida

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

## Errors

### 422 Knowledge Base List Request Unprocessable Entity Error

Erro de validação

- `detail` (list of ValidationError, optional)

## Types

### GetKnowledgeBaseListResponseModelDocumentsItem

- `type`: `file`
  - `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 GetKnowledgeBaseSummaryFileResponseModelDependentAgentsItem, required, deprecated) — Este campo está obsoleto e será removido no futuro; use o endpoint separado para obter agentes dependentes.
  - `auto_sync_info` (AutoSyncInfo, optional)
  - `external_sync_info` (ExternalFileSyncInfo, optional) — Rastreia o link para o arquivo original em uma fonte externa.
  - `folder_parent_id` (string, optional) — O ID da pasta pai ou null se o documento estiver no nível raiz.
  - `folder_path` (list of KnowledgeBaseFolderPathSegmentSummaryResponseModel, optional) — Os segmentos do caminho da pasta que levam a esta entidade, da raiz até a pasta pai.
  - `is_frozen` (boolean, optional, default: false)
  - `refresh_status` (FileRefreshStatus, optional) — Estado da atualização em andamento/da última atualização de um arquivo de base de conhecimento sincronizado externamente.
- `type`: `folder`
  - `access_info` (ResourceAccessInfo, required)
  - `children_count` (integer, required)
  - `document_count` (integer, required) — Número de documentos que não são pastas em qualquer parte da subárvore desta pasta (recursivo). A contagem para após 1.000;
  - `id` (string, required)
  - `metadata` (KnowledgeBaseDocumentMetadataResponseModel, required)
  - `name` (string, required)
  - `supported_usages` (list of enum, required)
    - Allowed values: `prompt`, `auto`
  - `dependent_agents` (list of GetKnowledgeBaseSummaryFolderResponseModelDependentAgentsItem, required, deprecated) — Este campo está obsoleto e será removido no futuro; use o endpoint separado para obter agentes dependentes.
  - `auto_sync_info` (AutoSyncInfo, optional)
  - `external_sync_info` (ExternalFolderSyncInfo, optional) — Metadados de uma pasta da base de conhecimento que espelha uma pasta de origem externa.
  - `folder_parent_id` (string, optional) — O ID da pasta pai ou null se o documento estiver no nível raiz.
  - `folder_path` (list of KnowledgeBaseFolderPathSegmentSummaryResponseModel, optional) — Os segmentos do caminho da pasta que levam a esta entidade, da raiz até a pasta pai.
  - `is_frozen` (boolean, optional, default: false)
- `type`: `text`
  - `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 GetKnowledgeBaseSummaryTextResponseModelDependentAgentsItem, required, deprecated) — Este campo está obsoleto e será removido no futuro; use o endpoint separado para obter agentes dependentes.
  - `folder_parent_id` (string, optional) — O ID da pasta pai ou null se o documento estiver no nível raiz.
  - `folder_path` (list of KnowledgeBaseFolderPathSegmentSummaryResponseModel, optional) — Os segmentos do caminho da pasta que levam a esta entidade, da raiz até a pasta pai.
- `type`: `url`
  - `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 GetKnowledgeBaseSummaryUrlResponseModelDependentAgentsItem, required, deprecated) — Este campo está obsoleto e será removido no futuro; use o endpoint separado para obter agentes dependentes.
  - `auto_sync_info` (AutoSyncInfo, optional)
  - `folder_parent_id` (string, optional) — O ID da pasta pai ou null se o documento estiver no nível raiz.
  - `folder_path` (list of KnowledgeBaseFolderPathSegmentSummaryResponseModel, optional) — Os segmentos do caminho da pasta que levam a esta entidade, da raiz até a pasta pai.

### ValidationError

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

### ResourceAccessInfo

- `is_creator` (boolean, required) — Indica se o usuário que faz a solicitação é o criador do agente
- `creator_name` (string, required) — Nome do criador do agente
- `creator_email` (string, required) — E-mail do criador do agente
- `role` (enum, required) — A função do usuário que faz a solicitação
  - Allowed values: `admin`, `editor`, `commenter`, `viewer`
- `anonymous_access_level_override` (enum, optional) — O nível de acesso para usuários anônimos. Se for None, o recurso não será compartilhado publicamente.
  - Allowed values: `admin`, `editor`, `commenter`, `viewer`
- `access_source` (enum, optional) — Por que o usuário solicitante tem acesso a este recurso. 'creator' = o chamador é o proprietário. 'explicit' = o chamador (ou um dos grupos do workspace dele) está listado em role_to_group_ids além do grupo everyone de todo o workspace. 'workspace_default' = o grupo everyone de todo o workspace está listado em role_to_group_ids (todos os membros não anônimos do workspace, incluindo administradores, veem este recurso). 'workspace_admin' = o chamador é administrador do workspace e a função de administrador é o *único* caminho de acesso; reservado para documentos que ninguém mais pode ver. Permite que a interface revele por que um visualizador com desvio de administrador vê um documento que não foi compartilhado explicitamente com ele.
  - 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)

### GetKnowledgeBaseSummaryFileResponseModelDependentAgentsItem

- `type`: `available`
  - `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) — Se o agente for um dependente transitivo, contém os IDs dos recursos dos quais o agente depende diretamente.
- `type`: `unknown`
  - `id` (string, required)
  - `referenced_resource_ids` (list of string, optional) — Se o agente for um dependente transitivo, contém os IDs dos recursos dos quais o agente depende diretamente.

### AutoSyncInfo

- `minimum_frequency_days` (integer, optional, default: 7) — Frequência mínima (em dias) para atualização do documento. O intervalo real pode ser menor, mas nunca maior.
- `auto_remove` (boolean, optional, default: false) — Se deve remover o documento se a URL ficar indisponível
- `consec_failures` (integer, optional, default: 0) — Número de falhas consecutivas de sincronização
- `next_refresh_by` (integer, optional) — Timestamp Unix da próxima sincronização agendada ou None (no caso de pastas)
- `auto_discover` (boolean, optional, default: false, deprecated) — Obsoleto. Este campo não tem mais efeito e será removido em uma versão futura.

### ExternalFileSyncInfo

Rastreia o link para o arquivo original em uma fonte externa.

- `type` ("google_drive", required) — Identificador do provedor
- `source_entity_id` (string, required) — ID da entidade no sistema externo
- `integration_connection_id` (string, required) — ID da instância de conexão da integração
- `source_parent_entity_id` (string, required) — ID da pasta no sistema externo do qual este arquivo foi sincronizado
- `source_mime_type` (string, required) — Tipo MIME original no sistema externo
- `source_modified_time` (datetime, required) — Hora da última modificação no sistema externo
- `root_folder_id` (string, optional) — ID da pasta da base de conhecimento da raiz de sincronização, usado para consultar todas as entidades em uma árvore de sincronização

### KnowledgeBaseFolderPathSegmentSummaryResponseModel

- `id` (string, required)

### FileRefreshStatus

Estado da atualização em andamento/da última atualização de um arquivo de base de conhecimento sincronizado externamente.

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

### GetKnowledgeBaseSummaryFolderResponseModelDependentAgentsItem

- `type`: `available`
  - `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) — Se o agente for um dependente transitivo, contém os IDs dos recursos dos quais o agente depende diretamente.
- `type`: `unknown`
  - `id` (string, required)
  - `referenced_resource_ids` (list of string, optional) — Se o agente for um dependente transitivo, contém os IDs dos recursos dos quais o agente depende diretamente.

### ExternalFolderSyncInfo

Metadados de uma pasta da base de conhecimento que espelha uma pasta de origem externa.

- `type` ("google_drive", required) — Identificador do provedor
- `source_entity_id` (string, required) — ID da entidade no sistema externo
- `integration_connection_id` (string, required) — ID da instância de conexão da integração
- `root_folder_id` (string, optional) — ID da pasta da base de conhecimento da raiz de sincronização. None significa que esta pasta é a raiz.
- `sync_cursor` (string, optional) — Cursor opaco para sincronização incremental, interpretado pelo provedor
- `last_sync_at` (integer, optional) — Timestamp Unix da última sincronização concluída

### GetKnowledgeBaseSummaryTextResponseModelDependentAgentsItem

- `type`: `available`
  - `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) — Se o agente for um dependente transitivo, contém os IDs dos recursos dos quais o agente depende diretamente.
- `type`: `unknown`
  - `id` (string, required)
  - `referenced_resource_ids` (list of string, optional) — Se o agente for um dependente transitivo, contém os IDs dos recursos dos quais o agente depende diretamente.

### GetKnowledgeBaseSummaryUrlResponseModelDependentAgentsItem

- `type`: `available`
  - `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) — Se o agente for um dependente transitivo, contém os IDs dos recursos dos quais o agente depende diretamente.
- `type`: `unknown`
  - `id` (string, required)
  - `referenced_resource_ids` (list of string, optional) — Se o agente for um dependente transitivo, contém os IDs dos recursos dos quais o agente depende diretamente.

### ValidationErrorLocItem

## Examples

**Response**

```json
{
  "documents": [
    {
      "type": "file",
      "access_info": {
        "is_creator": true,
        "creator_name": "John Doe",
        "creator_email": "john.doe@example.com",
        "role": "admin",
        "access_source": "creator"
      },
      "id": "id",
      "metadata": {
        "created_at_unix_secs": 1,
        "last_updated_at_unix_secs": 1,
        "size_bytes": 1
      },
      "name": "name",
      "supported_usages": [
        "prompt"
      ],
      "dependent_agents": [
        {
          "type": "available",
          "access_level": "admin",
          "created_at_unix_secs": 1,
          "id": "id",
          "name": "name"
        }
      ],
      "external_sync_info": {
        "type": "google_drive",
        "source_entity_id": "source_entity_id",
        "integration_connection_id": "integration_connection_id",
        "source_parent_entity_id": "source_parent_entity_id",
        "source_mime_type": "source_mime_type",
        "source_modified_time": "2024-01-15T09:30:00Z"
      },
      "folder_parent_id": "folder_parent_id",
      "folder_path": [
        {
          "id": "id"
        }
      ],
      "is_frozen": true
    }
  ],
  "has_more": true,
  "next_cursor": "next_cursor"
}
```

**SDK Code**

```python
import requests

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

querystring = {"ancestor_folder_id":"ancestor_folder_id","created_by_user_id":"created_by_user_id","cursor":"cursor","folders_first":"true","page_size":"1","parent_folder_id":"parent_folder_id","search":"search","show_only_owned_documents":"true","sort_by":"name","sort_direction":"asc","types":"[\"file\"]"}

response = requests.get(url, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api.elevenlabs.io/v1/convai/knowledge-base?ancestor_folder_id=ancestor_folder_id&created_by_user_id=created_by_user_id&cursor=cursor&folders_first=true&page_size=1&parent_folder_id=parent_folder_id&search=search&show_only_owned_documents=true&sort_by=name&sort_direction=asc&types=%5B%22file%22%5D';
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?ancestor_folder_id=ancestor_folder_id&created_by_user_id=created_by_user_id&cursor=cursor&folders_first=true&page_size=1&parent_folder_id=parent_folder_id&search=search&show_only_owned_documents=true&sort_by=name&sort_direction=asc&types=%5B%22file%22%5D"

	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?ancestor_folder_id=ancestor_folder_id&created_by_user_id=created_by_user_id&cursor=cursor&folders_first=true&page_size=1&parent_folder_id=parent_folder_id&search=search&show_only_owned_documents=true&sort_by=name&sort_direction=asc&types=%5B%22file%22%5D")

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?ancestor_folder_id=ancestor_folder_id&created_by_user_id=created_by_user_id&cursor=cursor&folders_first=true&page_size=1&parent_folder_id=parent_folder_id&search=search&show_only_owned_documents=true&sort_by=name&sort_direction=asc&types=%5B%22file%22%5D")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.elevenlabs.io/v1/convai/knowledge-base?ancestor_folder_id=ancestor_folder_id&created_by_user_id=created_by_user_id&cursor=cursor&folders_first=true&page_size=1&parent_folder_id=parent_folder_id&search=search&show_only_owned_documents=true&sort_by=name&sort_direction=asc&types=%5B%22file%22%5D');

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

```csharp
using RestSharp;

var client = new RestClient("https://api.elevenlabs.io/v1/convai/knowledge-base?ancestor_folder_id=ancestor_folder_id&created_by_user_id=created_by_user_id&cursor=cursor&folders_first=true&page_size=1&parent_folder_id=parent_folder_id&search=search&show_only_owned_documents=true&sort_by=name&sort_direction=asc&types=%5B%22file%22%5D");
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?ancestor_folder_id=ancestor_folder_id&created_by_user_id=created_by_user_id&cursor=cursor&folders_first=true&page_size=1&parent_folder_id=parent_folder_id&search=search&show_only_owned_documents=true&sort_by=name&sort_direction=asc&types=%5B%22file%22%5D")! 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()
```