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

# Hämta dokumentation från kunskapsbasen

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

Hämta information om specifik dokumentation som ingår i agentens kunskapsbas

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) — ID:t för ett dokument från kunskapsbasen. Det returneras när dokumentet läggs till.

### Query parameters

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

## Response

### 200

Lyckat svar

- `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) — Kanonisk representation av en kunskapsbasdokuments lagrade innehåll. HTML är den äldre standarden; dokument som skapades innan detta fält fanns tolkas som HTML.
      - Allowed values: `html`, `markdown`
    - `folder_parent_id` (string, optional, nullable) — ID:t för den överordnade mappen, eller null om dokumentet ligger på rotnivå.
    - `folder_path` (list of KnowledgeBaseFolderPathSegmentResponseModel, optional) — Mappsökvägens segment som leder till denna entitet, från roten till överordnad mapp.
  - `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) — Kanonisk representation av en kunskapsbasdokuments lagrade innehåll. HTML är den äldre standarden; dokument som skapades innan detta fält fanns tolkas som HTML.
      - Allowed values: `html`, `markdown`
    - `external_sync_info` (ExternalFileSyncInfo, optional, nullable) — Spårar länken tillbaka till originalfilen i en extern källa.
    - `folder_parent_id` (string, optional, nullable) — ID:t för den överordnade mappen, eller null om dokumentet ligger på rotnivå.
    - `folder_path` (list of KnowledgeBaseFolderPathSegmentResponseModel, optional) — Mappsökvägens segment som leder till denna entitet, från roten till överordnad mapp.
    - `is_frozen` (boolean, optional, default: false)
    - `refresh_status` (FileRefreshStatus, optional, nullable) — Pågående eller senaste uppdateringsstatus för en externt synkroniserad fil. Används av klienter för att visa synkroniseringsförlopp och inaktivera omsynkronisering medan en uppdatering står i kö eller bearbetas.
  - `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) — Kanonisk representation av en kunskapsbasdokuments lagrade innehåll. HTML är den äldre standarden; dokument som skapades innan detta fält fanns tolkas som HTML.
      - Allowed values: `html`, `markdown`
    - `folder_parent_id` (string, optional, nullable) — ID:t för den överordnade mappen, eller null om dokumentet ligger på rotnivå.
    - `folder_path` (list of KnowledgeBaseFolderPathSegmentResponseModel, optional) — Mappsökvägens segment som leder till denna entitet, från roten till överordnad mapp.
  - `type`: `folder` (GetKnowledgeBaseFolderResponseModel)
    - `access_info` (ResourceAccessInfo, required)
    - `children_count` (integer, required)
    - `document_count` (integer, required) — Antal dokument som inte är mappar någonstans i den här mappens underträd (rekursivt). Räkningen stoppas efter 1 000;
    - `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) — Senaste externa synkroniseringsjobbet för den här mappen, om något, som antingen pågår eller är avslutat. Används av klienter för att visa synkroniseringsförloppet.
    - `auto_sync_info` (AutoSyncInfo, optional, nullable)
    - `external_sync_info` (ExternalFolderSyncInfo, optional, nullable) — Metadata för en KB-mapp som speglar en extern källmapp.
    - `folder_parent_id` (string, optional, nullable) — ID:t för den överordnade mappen, eller null om dokumentet ligger på rotnivå.
    - `folder_path` (list of KnowledgeBaseFolderPathSegmentResponseModel, optional) — Mappsökvägens segment som leder till denna entitet, från roten till överordnad mapp.
    - `is_frozen` (boolean, optional, default: false)

## Errors

### 422 Unprocessable Entity Error

Valideringsfel

- `detail` (list of ValidationError, optional)

## Types

### ResourceAccessInfo

- `is_creator` (boolean, required) — Om användaren som gör begäran är agentens skapare
- `creator_name` (string, required) — Namn på agentens skapare
- `creator_email` (string, required) — E-postadress till agentens skapare
- `role` (enum, required) — Rollen för användaren som gör begäran
  - Allowed values: `admin`, `editor`, `commenter`, `viewer`
- `anonymous_access_level_override` (enum, optional, nullable) — Åtkomstnivån för anonyma användare. Om värdet är None delas resursen inte offentligt.
  - Allowed values: `admin`, `editor`, `commenter`, `viewer`
- `access_source` (enum, optional, nullable) — Varför den begärande användaren har åtkomst till den här resursen. 'creator' = anroparen är ägaren. 'explicit' = anroparen (eller en av deras arbetsytas grupper) finns listad i role_to_group_ids utöver den arbetsyteomfattande gruppen för alla. 'workspace_default' = den arbetsyteomfattande gruppen för alla finns listad i role_to_group_ids (alla icke-anonyma medlemmar i arbetsytan, inklusive administratörer, ser den här resursen). 'workspace_admin' = anroparen är administratör för arbetsytan och administratörsplatsen är den *enda* åtkomstvägen; reserverad för dokument som ingen annan kan se. Gör det möjligt för användargränssnittet att förklara varför en administratör som kringgår behörigheter ser ett dokument som inte uttryckligen har delats med dem.
  - 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) — Minsta frekvens (i dagar) för hur ofta dokumentet uppdateras. Det faktiska intervallet kan vara kortare, men aldrig längre.
- `auto_remove` (boolean, optional, default: false) — Om dokumentet ska tas bort om URL:en blir otillgänglig
- `auto_discover` (boolean, optional, default: false) — Om nya sidor som upptäcks under en uppdatering ska genomsökas och läggas till. Anges från det ägande genomsökningsjobbet vid skapandet; genomsökningsjobbet förblir den definitiva källan för upptäcktslogiken.
- `consec_failures` (integer, optional, default: 0) — Antal synkroniseringsfel i följd
- `next_refresh_by` (integer, optional, nullable) — Unix-tidsstämpel för nästa schemalagda synkronisering eller None (för mappar)

### KnowledgeBaseFolderPathSegmentResponseModel

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

### ExternalFileSyncInfo

Spårar länken tillbaka till originalfilen i en extern källa.

- `type` (enum, required) — Leverantörsidentifierare
  - Allowed values: `google_drive`
- `source_entity_id` (string, required) — Entitets-ID i det externa systemet
- `integration_connection_id` (string, required) — Instans-ID för integrationsanslutning
- `source_parent_entity_id` (string, required) — Mapp-ID i det externa system som filen synkroniserades från
- `source_mime_type` (string, required) — Ursprunglig MIME-typ i det externa systemet
- `source_modified_time` (string, required) — Senast ändrad-tid från det externa systemet
- `root_folder_id` (string, optional, nullable) — KB-mapp-ID för synkroniseringsroten, används för att fråga efter alla entiteter under ett synkroniseringsträd

### FileRefreshStatus

Pågående/senaste uppdateringsstatus för en externt synkroniserad KB-fil.

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

Metadata för en KB-mapp som speglar en extern källmapp.

- `type` (enum, required) — Leverantörsidentifierare
  - Allowed values: `google_drive`
- `source_entity_id` (string, required) — Entitets-ID i det externa systemet
- `integration_connection_id` (string, required) — Instans-ID för integrationsanslutning
- `root_folder_id` (string, optional, nullable) — KB-mapp-ID för synkroniseringsroten. None innebär att den här mappen är roten.
- `sync_cursor` (string, optional, nullable) — Ogenomskinlig markör för inkrementell synkronisering, tolkad av leverantören
- `last_sync_at` (integer, optional, nullable) — Unix-tidsstämpel för senast slutförda synkronisering

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