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

# Inhoud van URL-document vernieuwen

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

Vernieuw een URL-document handmatig door de inhoud opnieuw op te halen van de bron-URL.

Reference: https://elevenlabs.io/docs/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) — De id van een document uit de kennisbank. Deze wordt teruggegeven wanneer het document wordt toegevoegd.

## Response

### 200

Geslaagde response

- `conversational_ai_knowledge_base_document_refresh_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) — Canonieke weergave van de opgeslagen inhoud van een kennisbankdocument. HTML is de verouderde standaard; documenten die zijn gemaakt voordat dit veld bestond, worden geïnterpreteerd als HTML.
      - Allowed values: `html`, `markdown`
    - `folder_parent_id` (string, optional, nullable) — De ID van de bovenliggende map, of null als het document zich op hoofdniveau bevindt.
    - `folder_path` (list of KnowledgeBaseFolderPathSegmentResponseModel, optional) — De segmenten van het mappad naar deze entiteit, van de hoofdmap naar de bovenliggende map.
  - `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) — Canonieke weergave van de opgeslagen inhoud van een kennisbankdocument. HTML is de verouderde standaard; documenten die zijn gemaakt voordat dit veld bestond, worden geïnterpreteerd als HTML.
      - Allowed values: `html`, `markdown`
    - `external_sync_info` (ExternalFileSyncInfo, optional, nullable) — Houdt de link naar het oorspronkelijke bestand in een externe bron bij.
    - `folder_parent_id` (string, optional, nullable) — De ID van de bovenliggende map, of null als het document zich op hoofdniveau bevindt.
    - `folder_path` (list of KnowledgeBaseFolderPathSegmentResponseModel, optional) — De segmenten van het mappad naar deze entiteit, van de hoofdmap naar de bovenliggende map.
    - `is_frozen` (boolean, optional, default: false)
    - `refresh_status` (FileRefreshStatus, optional, nullable) — Status van een lopende of laatste vernieuwing voor een extern gesynchroniseerd bestand. Wordt door clients gebruikt om de synchronisatievoortgang weer te geven en opnieuw synchroniseren uit te schakelen wanneer een vernieuwing in de wachtrij staat of wordt verwerkt.
  - `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) — Canonieke weergave van de opgeslagen inhoud van een kennisbankdocument. HTML is de verouderde standaard; documenten die zijn gemaakt voordat dit veld bestond, worden geïnterpreteerd als HTML.
      - Allowed values: `html`, `markdown`
    - `folder_parent_id` (string, optional, nullable) — De ID van de bovenliggende map, of null als het document zich op hoofdniveau bevindt.
    - `folder_path` (list of KnowledgeBaseFolderPathSegmentResponseModel, optional) — De segmenten van het mappad naar deze entiteit, van de hoofdmap naar de bovenliggende map.
  - `type`: `folder` (GetKnowledgeBaseFolderResponseModel)
    - `access_info` (ResourceAccessInfo, required)
    - `children_count` (integer, required)
    - `document_count` (integer, required) — Aantal documenten die geen map zijn, overal in de substructuur van deze map (recursief). Het tellen stopt boven 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) — Meest recente externe synchronisatietaak voor deze map (in uitvoering of voltooid), indien aanwezig. Wordt door clients gebruikt om de synchronisatievoortgang weer te geven.
    - `auto_sync_info` (AutoSyncInfo, optional, nullable)
    - `external_sync_info` (ExternalFolderSyncInfo, optional, nullable) — Metadata voor een KB-map die een externe bronmap weerspiegelt.
    - `folder_parent_id` (string, optional, nullable) — De ID van de bovenliggende map, of null als het document zich op hoofdniveau bevindt.
    - `folder_path` (list of KnowledgeBaseFolderPathSegmentResponseModel, optional) — De segmenten van het mappad naar deze entiteit, van de hoofdmap naar de bovenliggende map.
    - `is_frozen` (boolean, optional, default: false)

## Errors

### 422 Unprocessable Entity Error

Validatiefout

- `detail` (list of ValidationError, optional)

## Types

### ResourceAccessInfo

- `is_creator` (boolean, required) — Of de gebruiker die de request doet de maker van de agent is
- `creator_name` (string, required) — Naam van de maker van de agent
- `creator_email` (string, required) — E-mailadres van de maker van de agent
- `role` (enum, required) — De rol van de gebruiker die de request uitvoert
  - Allowed values: `admin`, `editor`, `commenter`, `viewer`
- `anonymous_access_level_override` (enum, optional, nullable) — Het toegangsniveau voor anonieme gebruikers. Als dit None is, wordt de resource niet openbaar gedeeld.
  - Allowed values: `admin`, `editor`, `commenter`, `viewer`
- `access_source` (enum, optional, nullable) — Waarom de aanvragende gebruiker toegang heeft tot deze resource. 'creator' = de aanroeper is de eigenaar. 'explicit' = de aanroeper (of een van diens workspacegroepen) staat in role_to_group_ids, naast de workspacebrede everyone-groep. 'workspace_default' = de workspacebrede everyone-groep staat in role_to_group_ids (elk niet-anoniem workspacelid, inclusief beheerders, ziet deze resource). 'workspace_admin' = de aanroeper is een workspacebeheerder en de beheerdersrol is de *enige* manier om toegang te krijgen; gereserveerd voor documenten die niemand anders kan zien. Hiermee kan de UI uitleggen waarom een kijker die beheerdersrechten omzeilt een document ziet dat niet expliciet met diegene is gedeeld.
  - 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 frequentie (in dagen) waarmee het document wordt vernieuwd. Het werkelijke interval kan korter zijn, maar nooit langer.
- `auto_remove` (boolean, optional, default: false) — Of het document moet worden verwijderd als de URL niet meer beschikbaar is
- `consec_failures` (integer, optional, default: 0) — Aantal opeenvolgende synchronisatiefouten
- `next_refresh_by` (integer, optional, nullable) — Unix-timestamp voor de volgende geplande synchronisatie of None (in het geval van mappen)
- `auto_discover` (boolean, optional, default: false, deprecated) — Verouderd. Dit veld heeft geen effect meer en wordt in een toekomstige release verwijderd.

### KnowledgeBaseFolderPathSegmentResponseModel

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

### ExternalFileSyncInfo

Houdt de link naar het oorspronkelijke bestand in een externe bron bij.

- `type` (enum, required) — Provideridentificatie
  - Allowed values: `google_drive`
- `source_entity_id` (string, required) — Entity-ID in het externe systeem
- `integration_connection_id` (string, required) — Instance-ID van de integratieverbinding
- `source_parent_entity_id` (string, required) — Map-ID in het externe systeem waarvan dit bestand is gesynchroniseerd
- `source_mime_type` (string, required) — Oorspronkelijk MIME-type in het externe systeem
- `source_modified_time` (string, required) — Tijd van laatste wijziging uit het externe systeem
- `root_folder_id` (string, optional, nullable) — Map-ID van de KB-synchronisatieroot, gebruikt om alle entiteiten onder een synchronisatieboom op te vragen

### FileRefreshStatus

Status van een lopende/laatste vernieuwing voor een extern gesynchroniseerd KB-bestand.

- `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 voor een KB-map die een externe bronmap weerspiegelt.

- `type` (enum, required) — Provideridentificatie
  - Allowed values: `google_drive`
- `source_entity_id` (string, required) — Entity-ID in het externe systeem
- `integration_connection_id` (string, required) — Instance-ID van de integratieverbinding
- `root_folder_id` (string, optional, nullable) — Map-ID van de KB-synchronisatieroot. None betekent dat deze map de root is.
- `sync_cursor` (string, optional, nullable) — Ondoorzichtige cursor voor incrementele synchronisatie, geïnterpreteerd door de provider
- `last_sync_at` (integer, optional, nullable) — Unix-timestamp van de laatst voltooide synchronisatie

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