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

# Pobierz dokumentację z bazy wiedzy

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

Pobiera szczegóły konkretnej dokumentacji wchodzącej w skład bazy wiedzy agenta

Reference: https://elevenlabs.io/docs/eleven-agents/api-reference/knowledge-base/get-document

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

### Path parameters

- `documentation_id` (string, required) — ID dokumentu z bazy wiedzy. Jest zwracane przy dodawaniu dokumentu.

### Query parameters

- `agent_id` (string, optional, default: )

## Response

### 200

Pomyślna odpowiedź

- `DocumentsGetResponse`
  - `type`: `url`
    - `access_info` (ResourceAccessInfo, required)
    - `extracted_inner_html` (string, required)
    - `id` (string, required)
    - `metadata` (KnowledgeBaseDocumentMetadataResponseModel, required)
    - `name` (string, required)
    - `supported_usages` (list of enum, required)
      - Allowed values: `prompt`, `auto`
    - `url` (string, required)
    - `auto_sync_info` (AutoSyncInfo, optional)
    - `content_format` (enum, optional, default: html) — Kanoniczna reprezentacja przechowywanej treści dokumentu bazy wiedzy. HTML jest starszym formatem domyślnym; dokumenty utworzone przed dodaniem tego pola są interpretowane jako HTML.
      - Allowed values: `html`, `markdown`
    - `folder_parent_id` (string, optional) — ID folderu nadrzędnego albo null, jeśli dokument znajduje się w katalogu głównym.
    - `folder_path` (list of KnowledgeBaseFolderPathSegmentResponseModel, optional) — Segmenty ścieżki folderów prowadzące do tego elementu, od katalogu głównego do folderu nadrzędnego.
  - `type`: `file`
    - `access_info` (ResourceAccessInfo, required)
    - `extracted_inner_html` (string, required)
    - `filename` (string, required)
    - `id` (string, required)
    - `metadata` (KnowledgeBaseDocumentMetadataResponseModel, required)
    - `name` (string, required)
    - `supported_usages` (list of enum, required)
      - Allowed values: `prompt`, `auto`
    - `auto_sync_info` (AutoSyncInfo, optional)
    - `content_format` (enum, optional, default: html) — Kanoniczna reprezentacja przechowywanej treści dokumentu bazy wiedzy. HTML jest starszym formatem domyślnym; dokumenty utworzone przed dodaniem tego pola są interpretowane jako HTML.
      - Allowed values: `html`, `markdown`
    - `external_sync_info` (ExternalFileSyncInfo, optional) — Śledzi link do oryginalnego pliku w zewnętrznym źródle.
    - `folder_parent_id` (string, optional) — ID folderu nadrzędnego albo null, jeśli dokument znajduje się w katalogu głównym.
    - `folder_path` (list of KnowledgeBaseFolderPathSegmentResponseModel, optional) — Segmenty ścieżki folderów prowadzące do tego elementu, od katalogu głównego do folderu nadrzędnego.
    - `is_frozen` (boolean, optional, default: false)
    - `refresh_status` (FileRefreshStatus, optional) — Stan trwającego lub ostatniego odświeżania pliku synchronizowanego zewnętrznie. Klienci używają go do wyświetlania postępu synchronizacji i wyłączania ponownej synchronizacji, gdy odświeżanie oczekuje w kolejce lub jest przetwarzane.
  - `type`: `text`
    - `access_info` (ResourceAccessInfo, required)
    - `extracted_inner_html` (string, required)
    - `id` (string, required)
    - `metadata` (KnowledgeBaseDocumentMetadataResponseModel, required)
    - `name` (string, required)
    - `supported_usages` (list of enum, required)
      - Allowed values: `prompt`, `auto`
    - `content_format` (enum, optional, default: html) — Kanoniczna reprezentacja przechowywanej treści dokumentu bazy wiedzy. HTML jest starszym formatem domyślnym; dokumenty utworzone przed dodaniem tego pola są interpretowane jako HTML.
      - Allowed values: `html`, `markdown`
    - `folder_parent_id` (string, optional) — ID folderu nadrzędnego albo null, jeśli dokument znajduje się w katalogu głównym.
    - `folder_path` (list of KnowledgeBaseFolderPathSegmentResponseModel, optional) — Segmenty ścieżki folderów prowadzące do tego elementu, od katalogu głównego do folderu nadrzędnego.
  - `type`: `folder`
    - `access_info` (ResourceAccessInfo, required)
    - `children_count` (integer, required)
    - `document_count` (integer, required) — Liczba dokumentów niebędących folderami w całym poddrzewie tego folderu (rekurencyjnie). Liczenie kończy się po 1000;
    - `id` (string, required)
    - `metadata` (KnowledgeBaseDocumentMetadataResponseModel, required)
    - `name` (string, required)
    - `supported_usages` (list of enum, required)
      - Allowed values: `prompt`, `auto`
    - `active_sync_job` (KbExternalSyncJob, optional) — Najnowsze zewnętrzne zadanie synchronizacji dla tego folderu (w toku lub zakończone), jeśli istnieje. Klienci używają go do wyświetlania postępu synchronizacji.
    - `auto_sync_info` (AutoSyncInfo, optional)
    - `external_sync_info` (ExternalFolderSyncInfo, optional) — Metadane folderu bazy wiedzy odzwierciedlającego zewnętrzny folder źródłowy.
    - `folder_parent_id` (string, optional) — ID folderu nadrzędnego albo null, jeśli dokument znajduje się w katalogu głównym.
    - `folder_path` (list of KnowledgeBaseFolderPathSegmentResponseModel, optional) — Segmenty ścieżki folderów prowadzące do tego elementu, od katalogu głównego do folderu nadrzędnego.
    - `is_frozen` (boolean, optional, default: false)

## Errors

### 422 Documents Get Request Unprocessable Entity Error

Błąd walidacji

- `detail` (list of ValidationError, optional)

## Types

### ResourceAccessInfo

- `is_creator` (boolean, required) — Czy użytkownik wysyłający żądanie jest twórcą agenta
- `creator_name` (string, required) — Nazwa twórcy agenta
- `creator_email` (string, required) — E-mail twórcy agenta
- `role` (enum, required) — Rola użytkownika wysyłającego żądanie
  - Allowed values: `admin`, `editor`, `commenter`, `viewer`
- `anonymous_access_level_override` (enum, optional) — Poziom dostępu dla anonimowych użytkowników. Jeśli None, zasób nie jest publicznie udostępniany.
  - Allowed values: `admin`, `editor`, `commenter`, `viewer`
- `access_source` (enum, optional) — Dlaczego użytkownik wysyłający żądanie ma dostęp do tego zasobu. 'creator' = wywołujący jest właścicielem. 'explicit' = wywołujący (lub jedna z jego grup workspace) jest wymieniony w role_to_group_ids poza ogólną grupą everyone dla workspace. 'workspace_default' = ogólna grupa everyone dla workspace jest wymieniona w role_to_group_ids (ten zasób widzi każdy nieanonimowy członek workspace, w tym administratorzy). 'workspace_admin' = wywołujący jest administratorem workspace, a uprawnienia administratora są *jedyną* ścieżką dostępu; zarezerwowane dla dokumentów, których nikt inny nie może zobaczyć. Pozwala interfejsowi wyjaśnić, dlaczego użytkownik omijający ograniczenia jako administrator widzi dokument, który nie został mu wyraźnie udostępniony.
  - 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)

### AutoSyncInfo

- `minimum_frequency_days` (integer, optional, default: 7) — Minimalna częstotliwość odświeżania dokumentu (w dniach). Rzeczywisty odstęp może być krótszy, ale nigdy dłuższy.
- `auto_remove` (boolean, optional, default: false) — Czy usunąć dokument, jeśli URL stanie się niedostępny
- `consec_failures` (integer, optional, default: 0) — Liczba kolejnych błędów synchronizacji
- `next_refresh_by` (integer, optional) — Znacznik czasu Unix następnej zaplanowanej synchronizacji lub None (w przypadku folderów)
- `auto_discover` (boolean, optional, default: false, deprecated) — Przestarzałe. To pole nie ma już żadnego efektu i zostanie usunięte w przyszłej wersji.

### KnowledgeBaseFolderPathSegmentResponseModel

- `id` (string, required)
- `name` (string, optional)

### ExternalFileSyncInfo

Śledzi link do oryginalnego pliku w zewnętrznym źródle.

- `type` ("google_drive", required) — Identyfikator dostawcy
- `source_entity_id` (string, required) — ID encji w systemie zewnętrznym
- `integration_connection_id` (string, required) — Identyfikator instancji połączenia integracji
- `source_parent_entity_id` (string, required) — ID folderu w systemie zewnętrznym, z którego zsynchronizowano ten plik
- `source_mime_type` (string, required) — Oryginalny typ MIME w systemie zewnętrznym
- `source_modified_time` (datetime, required) — Czas ostatniej modyfikacji w systemie zewnętrznym
- `root_folder_id` (string, optional) — Identyfikator folderu KB katalogu głównego synchronizacji, używany do wyszukiwania wszystkich elementów w drzewie synchronizacji

### FileRefreshStatus

Stan trwającego/ostatniego odświeżania pliku KB synchronizowanego zewnętrznie.

- `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)

### KbExternalSyncJob

- `type` ("google_drive", required)
- `folder_id` (string, required)
- `integration_connection_id` (string, required)
- `triggered_by` (enum, required)
  - Allowed values: `on_demand`, `on_connect`, `auto`
- `updated_at` (integer, required)
- `id` (string, required)
- `created_at` (integer, required)
- `status` (enum, optional, default: queued)
  - Allowed values: `queued`, `processing`, `succeeded`, `failed`, `skipped`, `cancelled`
- `sync_type` (enum, optional)
  - Allowed values: `full`, `incremental`
- `items_identified` (integer, optional, default: 0)
- `items_processed` (integer, optional, default: 0)
- `error_message` (string, optional)
- `started_at` (integer, optional)
- `completed_at` (integer, optional)

### ExternalFolderSyncInfo

Metadane folderu bazy wiedzy odzwierciedlającego zewnętrzny folder źródłowy.

- `type` ("google_drive", required) — Identyfikator dostawcy
- `source_entity_id` (string, required) — ID encji w systemie zewnętrznym
- `integration_connection_id` (string, required) — Identyfikator instancji połączenia integracji
- `root_folder_id` (string, optional) — Identyfikator folderu KB katalogu głównego synchronizacji. None oznacza, że ten folder jest katalogiem głównym.
- `sync_cursor` (string, optional) — Nieprzezroczysty kursor synchronizacji przyrostowej interpretowany przez dostawcę
- `last_sync_at` (integer, optional) — Znacznik czasu Unix ostatniej ukończonej synchronizacji

### ValidationError

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

### ValidationErrorLocItem

- string
- integer

## Examples

**Response**

```json
{
  "type": "url",
  "access_info": {
    "is_creator": true,
    "creator_name": "John Doe",
    "creator_email": "john.doe@example.com",
    "role": "admin",
    "anonymous_access_level_override": "admin",
    "access_source": "creator"
  },
  "extracted_inner_html": "extracted_inner_html",
  "id": "id",
  "metadata": {
    "created_at_unix_secs": 1,
    "last_updated_at_unix_secs": 1,
    "size_bytes": 1
  },
  "name": "name",
  "supported_usages": [
    "prompt"
  ],
  "url": "url",
  "auto_sync_info": {
    "minimum_frequency_days": 1,
    "auto_remove": true,
    "consec_failures": 1,
    "next_refresh_by": 1
  },
  "content_format": "html",
  "folder_parent_id": "folder_parent_id",
  "folder_path": [
    {
      "id": "id",
      "name": "name"
    }
  ]
}
```

**SDK Code**

```python
import requests

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

querystring = {"agent_id":"agent_id"}

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

print(response.json())
```

```javascript
const url = 'https://api.elevenlabs.io/v1/convai/knowledge-base/21m00Tcm4TlvDq8ikWAM?agent_id=agent_id';
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/21m00Tcm4TlvDq8ikWAM?agent_id=agent_id"

	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/21m00Tcm4TlvDq8ikWAM?agent_id=agent_id")

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/21m00Tcm4TlvDq8ikWAM?agent_id=agent_id")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

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

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

```csharp
using RestSharp;

var client = new RestClient("https://api.elevenlabs.io/v1/convai/knowledge-base/21m00Tcm4TlvDq8ikWAM?agent_id=agent_id");
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/21m00Tcm4TlvDq8ikWAM?agent_id=agent_id")! 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()
```