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

# Recupera documentazione dalla knowledge base

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

Ottieni i dettagli di una documentazione specifica che fa parte della knowledge base dell'agente

Reference: https://elevenlabs.io/docs/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) — L'ID di un documento della knowledge base. Viene restituito all'aggiunta del documento.

### Query parameters

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

## Response

### 200

Risposta riuscita

- `conversational_ai_knowledge_base_documents_get_Response_200`
  - `type`: `url` (GetKnowledgeBaseURLResponseModel)
    - `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, nullable)
    - `content_format` (enum, optional, default: html) — Rappresentazione canonica del contenuto archiviato di un documento della knowledge base. HTML è il valore predefinito legacy; i documenti creati prima dell'esistenza di questo campo vengono interpretati come HTML.
      - Allowed values: `html`, `markdown`
    - `folder_parent_id` (string, optional, nullable) — L'ID della cartella principale o null se il documento si trova al livello root.
    - `folder_path` (list of KnowledgeBaseFolderPathSegmentResponseModel, optional) — I segmenti del path della cartella che portano a questa entità, dalla root alla cartella padre.
  - `type`: `file` (GetKnowledgeBaseFileResponseModel)
    - `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, nullable)
    - `content_format` (enum, optional, default: html) — Rappresentazione canonica del contenuto archiviato di un documento della knowledge base. HTML è il valore predefinito legacy; i documenti creati prima dell'esistenza di questo campo vengono interpretati come HTML.
      - Allowed values: `html`, `markdown`
    - `external_sync_info` (ExternalFileSyncInfo, optional, nullable) — Tiene traccia del link al file originale in una fonte esterna.
    - `folder_parent_id` (string, optional, nullable) — L'ID della cartella principale o null se il documento si trova al livello root.
    - `folder_path` (list of KnowledgeBaseFolderPathSegmentResponseModel, optional) — I segmenti del path della cartella che portano a questa entità, dalla root alla cartella padre.
    - `is_frozen` (boolean, optional, default: false)
    - `refresh_status` (FileRefreshStatus, optional, nullable) — Stato dell'aggiornamento in corso o dell'ultimo aggiornamento per un file sincronizzato esternamente. Utilizzato dai client per mostrare l'avanzamento della sincronizzazione e disabilitare la risincronizzazione mentre un aggiornamento è in coda o in elaborazione.
  - `type`: `text` (GetKnowledgeBaseTextResponseModel)
    - `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) — Rappresentazione canonica del contenuto archiviato di un documento della knowledge base. HTML è il valore predefinito legacy; i documenti creati prima dell'esistenza di questo campo vengono interpretati come HTML.
      - Allowed values: `html`, `markdown`
    - `folder_parent_id` (string, optional, nullable) — L'ID della cartella principale o null se il documento si trova al livello root.
    - `folder_path` (list of KnowledgeBaseFolderPathSegmentResponseModel, optional) — I segmenti del path della cartella che portano a questa entità, dalla root alla cartella padre.
  - `type`: `folder` (GetKnowledgeBaseFolderResponseModel)
    - `access_info` (ResourceAccessInfo, required)
    - `children_count` (integer, required)
    - `document_count` (integer, required) — Numero di documenti non cartella presenti in qualsiasi punto del sottoalbero di questa cartella, ricorsivamente. Il conteggio si interrompe oltre 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, nullable) — Processo di sincronizzazione esterna più recente per questa cartella, in corso o completato, se presente. Usato dai client per mostrare l'avanzamento della sincronizzazione.
    - `auto_sync_info` (AutoSyncInfo, optional, nullable)
    - `external_sync_info` (ExternalFolderSyncInfo, optional, nullable) — Metadati per una cartella della knowledge base che rispecchia una cartella di origine esterna.
    - `folder_parent_id` (string, optional, nullable) — L'ID della cartella principale o null se il documento si trova al livello root.
    - `folder_path` (list of KnowledgeBaseFolderPathSegmentResponseModel, optional) — I segmenti del path della cartella che portano a questa entità, dalla root alla cartella padre.
    - `is_frozen` (boolean, optional, default: false)

## Errors

### 422 Unprocessable Entity Error

Errore di convalida

- `detail` (list of ValidationError, optional)

## Types

### ResourceAccessInfo

- `is_creator` (boolean, required) — Se l'utente che effettua la richiesta è il creatore dell'agente
- `creator_name` (string, required) — Nome del creatore dell'agente
- `creator_email` (string, required) — Email del creatore dell'agente
- `role` (enum, required) — Il ruolo dell'utente che effettua la richiesta
  - Allowed values: `admin`, `editor`, `commenter`, `viewer`
- `anonymous_access_level_override` (enum, optional, nullable) — Il livello di accesso per gli utenti anonimi. Se è None, la risorsa non è condivisa pubblicamente.
  - Allowed values: `admin`, `editor`, `commenter`, `viewer`
- `access_source` (enum, optional, nullable) — Motivo per cui l'utente richiedente ha accesso a questa risorsa. 'creator' = il chiamante è il proprietario. 'explicit' = il chiamante, o uno dei suoi gruppi del workspace, è elencato in role_to_group_ids oltre al gruppo everyone dell'intero workspace. 'workspace_default' = il gruppo everyone dell'intero workspace è elencato in role_to_group_ids (ogni membro non anonimo del workspace, inclusi gli amministratori, vede questa risorsa). 'workspace_admin' = il chiamante è un amministratore del workspace e il ruolo di amministratore è l'*unica* modalità di accesso; riservato ai documenti che nessun altro può vedere. Consente all'interfaccia di indicare perché un visualizzatore con bypass da amministratore vede un documento che non è stato condiviso esplicitamente con lui.
  - 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) — Frequenza minima, in giorni, con cui il documento viene aggiornato. L'intervallo effettivo può essere più breve, mai più lungo.
- `auto_remove` (boolean, optional, default: false) — Indica se rimuovere il documento se l'URL non è più disponibile
- `auto_discover` (boolean, optional, default: false) — Se le nuove pagine rilevate durante un aggiornamento vengono sottoposte a crawling e aggiunte. Viene impostato dal job di crawling proprietario al momento della creazione; il job di crawling rimane la fonte di riferimento per la logica di rilevamento.
- `consec_failures` (integer, optional, default: 0) — Numero di errori di sincronizzazione consecutivi
- `next_refresh_by` (integer, optional, nullable) — Timestamp Unix della successiva sincronizzazione pianificata oppure None, nel caso delle cartelle

### KnowledgeBaseFolderPathSegmentResponseModel

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

### ExternalFileSyncInfo

Tiene traccia del link al file originale in una fonte esterna.

- `type` (enum, required) — Identificatore del provider
  - Allowed values: `google_drive`
- `source_entity_id` (string, required) — ID dell'entità nel sistema esterno
- `integration_connection_id` (string, required) — ID dell'istanza di connessione dell'integrazione
- `source_parent_entity_id` (string, required) — ID della cartella nel sistema esterno da cui è stato sincronizzato questo file
- `source_mime_type` (string, required) — Tipo MIME originale nel sistema esterno
- `source_modified_time` (string, required) — Data e ora dell'ultima modifica dal sistema esterno
- `root_folder_id` (string, optional, nullable) — ID della cartella KB della radice di sincronizzazione, usato per interrogare tutte le entità in un albero di sincronizzazione

### FileRefreshStatus

Stato dell'aggiornamento in corso o dell'ultimo aggiornamento per un file della knowledge base sincronizzato esternamente.

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

### KbExternalSyncJob

- `type` (enum, required)
  - Allowed values: `google_drive`
- `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, nullable)
  - Allowed values: `full`, `incremental`
- `items_identified` (integer, optional, default: 0)
- `items_processed` (integer, optional, default: 0)
- `error_message` (string, optional, nullable)
- `started_at` (integer, optional, nullable)
- `completed_at` (integer, optional, nullable)

### ExternalFolderSyncInfo

Metadati per una cartella della knowledge base che rispecchia una cartella di origine esterna.

- `type` (enum, required) — Identificatore del provider
  - Allowed values: `google_drive`
- `source_entity_id` (string, required) — ID dell'entità nel sistema esterno
- `integration_connection_id` (string, required) — ID dell'istanza di connessione dell'integrazione
- `root_folder_id` (string, optional, nullable) — ID della cartella KB della radice di sincronizzazione. None indica che questa cartella è la radice.
- `sync_cursor` (string, optional, nullable) — Cursore opaco per la sincronizzazione incrementale, interpretato dal provider
- `last_sync_at` (integer, optional, nullable) — Timestamp Unix dell'ultima sincronizzazione completata

### ValidationError

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

### ValidationErrorLocItems

## Examples

**Response**

```json
{
  "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
  },
  "content_format": "html",
  "extracted_inner_html": "string",
  "folder_parent_id": "string",
  "folder_path": [
    {
      "id": "string",
      "name": "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"
}
```

**SDK Code**

```python
import requests

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

response = requests.get(url)

print(response.json())
```

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

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

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")
  .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');

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

```csharp
using RestSharp;

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