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

# URL-Dokumentinhalt aktualisieren

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

Aktualisieren Sie ein URL-Dokument manuell, indem Sie seinen Inhalt erneut von der Quell-URL abrufen.

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

## 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) — Die ID eines Dokuments aus der Wissensdatenbank. Sie wird beim Hinzufügen eines Dokuments zurückgegeben.

## Response

### 200

Erfolgreiche Antwort

- `DocumentRefreshResponse`
  - `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) — Kanonische Darstellung des gespeicherten Inhalts eines Wissensdatenbankdokuments. HTML ist der Legacy-Standard; Dokumente, die vor Einführung dieses Feldes erstellt wurden, werden als HTML interpretiert.
      - Allowed values: `html`, `markdown`
    - `folder_parent_id` (string, optional) — Die ID des übergeordneten Ordners oder null, wenn sich das Dokument auf der Stammebene befindet.
    - `folder_path` (list of KnowledgeBaseFolderPathSegmentResponseModel, optional) — Die Ordnerpfadsegmente zu dieser Entität, vom Stammordner bis zum übergeordneten Ordner.
  - `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) — Kanonische Darstellung des gespeicherten Inhalts eines Wissensdatenbankdokuments. HTML ist der Legacy-Standard; Dokumente, die vor Einführung dieses Feldes erstellt wurden, werden als HTML interpretiert.
      - Allowed values: `html`, `markdown`
    - `external_sync_info` (ExternalFileSyncInfo, optional) — Erfasst den Link zur Originaldatei in einer externen Quelle.
    - `folder_parent_id` (string, optional) — Die ID des übergeordneten Ordners oder null, wenn sich das Dokument auf der Stammebene befindet.
    - `folder_path` (list of KnowledgeBaseFolderPathSegmentResponseModel, optional) — Die Ordnerpfadsegmente zu dieser Entität, vom Stammordner bis zum übergeordneten Ordner.
    - `is_frozen` (boolean, optional, default: false)
    - `refresh_status` (FileRefreshStatus, optional) — Status der laufenden oder letzten Aktualisierung einer extern synchronisierten Datei. Wird von Clients verwendet, um den Synchronisierungsfortschritt anzuzeigen und eine erneute Synchronisierung zu deaktivieren, während eine Aktualisierung in der Warteschlange steht oder verarbeitet wird.
  - `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) — Kanonische Darstellung des gespeicherten Inhalts eines Wissensdatenbankdokuments. HTML ist der Legacy-Standard; Dokumente, die vor Einführung dieses Feldes erstellt wurden, werden als HTML interpretiert.
      - Allowed values: `html`, `markdown`
    - `folder_parent_id` (string, optional) — Die ID des übergeordneten Ordners oder null, wenn sich das Dokument auf der Stammebene befindet.
    - `folder_path` (list of KnowledgeBaseFolderPathSegmentResponseModel, optional) — Die Ordnerpfadsegmente zu dieser Entität, vom Stammordner bis zum übergeordneten Ordner.
  - `type`: `folder`
    - `access_info` (ResourceAccessInfo, required)
    - `children_count` (integer, required)
    - `document_count` (integer, required) — Anzahl der Nicht-Ordner-Dokumente im gesamten Unterbaum dieses Ordners (rekursiv). Die Zählung endet bei mehr als 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) — Neuester externer Synchronisierungsjob für diesen Ordner (laufend oder abgeschlossen), falls vorhanden. Wird von Clients zur Darstellung des Synchronisierungsfortschritts verwendet.
    - `auto_sync_info` (AutoSyncInfo, optional)
    - `external_sync_info` (ExternalFolderSyncInfo, optional) — Metadaten für einen KB-Ordner, der einen externen Quellordner spiegelt.
    - `folder_parent_id` (string, optional) — Die ID des übergeordneten Ordners oder null, wenn sich das Dokument auf der Stammebene befindet.
    - `folder_path` (list of KnowledgeBaseFolderPathSegmentResponseModel, optional) — Die Ordnerpfadsegmente zu dieser Entität, vom Stammordner bis zum übergeordneten Ordner.
    - `is_frozen` (boolean, optional, default: false)

## Errors

### 422 Document Refresh Request Unprocessable Entity Error

Validierungsfehler

- `detail` (list of ValidationError, optional)

## Types

### ResourceAccessInfo

- `is_creator` (boolean, required) — Ob der Nutzer, der die Anfrage stellt, den Agenten erstellt hat.
- `creator_name` (string, required) — Name des Erstellers des Agenten
- `creator_email` (string, required) — E-Mail-Adresse des Erstellers des Agents
- `role` (enum, required) — Die Rolle des Benutzers, der die Anfrage stellt
  - Allowed values: `admin`, `editor`, `commenter`, `viewer`
- `anonymous_access_level_override` (enum, optional) — Die Zugriffsebene für anonyme Nutzer. Bei None ist die Ressource nicht öffentlich freigegeben.
  - Allowed values: `admin`, `editor`, `commenter`, `viewer`
- `access_source` (enum, optional) — Warum der anfragende Nutzer Zugriff auf diese Ressource hat. 'creator' = der Aufrufer ist der Eigentümer. 'explicit' = der Aufrufer (oder eine seiner Workspace-Gruppen) ist zusätzlich zur workspaceweiten Gruppe „everyone“ in role_to_group_ids aufgeführt. 'workspace_default' = die workspaceweite Gruppe „everyone“ ist in role_to_group_ids aufgeführt (jedes nicht anonyme Workspace-Mitglied, einschließlich Administratoren, sieht diese Ressource). 'workspace_admin' = der Aufrufer ist Workspace-Administrator und der Administratorzugang ist der *einzige* Zugriffsweg; reserviert für Dokumente, die sonst niemand sehen kann. Ermöglicht der Benutzeroberfläche offenzulegen, warum ein Betrachter mit Administrator-Bypass ein Dokument sieht, das nicht explizit mit ihm geteilt wurde.
  - 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) — Minimale Häufigkeit (in Tagen), mit der das Dokument aktualisiert wird. Das tatsächliche Intervall kann kürzer, aber nie länger sein.
- `auto_remove` (boolean, optional, default: false) — Ob das Dokument entfernt werden soll, wenn die URL nicht mehr verfügbar ist
- `consec_failures` (integer, optional, default: 0) — Anzahl aufeinanderfolgender Synchronisierungsfehler
- `next_refresh_by` (integer, optional) — Unix-Zeitstempel für die nächste geplante Synchronisierung oder None bei Ordnern
- `auto_discover` (boolean, optional, default: false, deprecated) — Veraltet. Dieses Feld hat keine Wirkung mehr und wird in einer zukünftigen Version entfernt.

### KnowledgeBaseFolderPathSegmentResponseModel

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

### ExternalFileSyncInfo

Erfasst den Link zur Originaldatei in einer externen Quelle.

- `type` ("google_drive", required) — Anbieterkennung
- `source_entity_id` (string, required) — Entitäts-ID im externen System
- `integration_connection_id` (string, required) — Instanz-ID der Integrationsverbindung
- `source_parent_entity_id` (string, required) — Ordner-ID im externen System, aus dem diese Datei synchronisiert wurde
- `source_mime_type` (string, required) — Ursprünglicher MIME-Typ im externen System
- `source_modified_time` (datetime, required) — Zeitpunkt der letzten Änderung im externen System
- `root_folder_id` (string, optional) — Wissensbasisordner-ID der Synchronisierungswurzel, mit der alle Entitäten in einem Synchronisierungsbaum abgefragt werden

### FileRefreshStatus

Status der laufenden oder letzten Aktualisierung einer extern synchronisierten Wissensbasisdatei.

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

Metadaten für einen KB-Ordner, der einen externen Quellordner spiegelt.

- `type` ("google_drive", required) — Anbieterkennung
- `source_entity_id` (string, required) — Entitäts-ID im externen System
- `integration_connection_id` (string, required) — Instanz-ID der Integrationsverbindung
- `root_folder_id` (string, optional) — Wissensbasisordner-ID der Synchronisierungswurzel. None bedeutet, dass dieser Ordner die Wurzel ist.
- `sync_cursor` (string, optional) — Opaker Cursor für inkrementelle Synchronisierung, der vom Anbieter interpretiert wird
- `last_sync_at` (integer, optional) — Unix-Zeitstempel der zuletzt abgeschlossenen Synchronisierung

### ValidationError

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

### ValidationErrorLocItem

## 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/refresh"

response = requests.post(url)

print(response.json())
```

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

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/refresh"

	req, _ := http.NewRequest("POST", 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/refresh")

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

request = Net::HTTP::Post.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.post("https://api.elevenlabs.io/v1/convai/knowledge-base/21m00Tcm4TlvDq8ikWAM/refresh")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

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

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

```csharp
using RestSharp;

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

```swift
import Foundation

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

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