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

# Atualizar documento

PATCH https://api.elevenlabs.io/v1/convai/knowledge-base/{documentation_id}
Content-Type: application/json

Atualiza o nome e/ou o conteúdo de um documento.

Reference: https://elevenlabs.io/docs/api-reference/knowledge-base/update

## 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) — O ID de um documento da base de conhecimento. Ele é retornado ao adicionar o documento.

### Body (application/json)

This endpoint expects a Body_Update_document_v1_convai_knowledge_base__documentation_id__patch.

- `name` (string, optional, nullable) — Um nome personalizado e legível para humanos para o documento.
- `content` (string, optional, nullable) — Conteúdo atualizado do documento. Compatível apenas com documentos de texto, documentos de URL com sincronização automática desativada e documentos de arquivo que não são sincronizados de uma fonte externa.

## Response

### 200

Resposta bem-sucedida

- `conversational_ai_knowledge_base_documents_update_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) — Representação canônica do conteúdo armazenado de um documento da base de conhecimento. HTML é o padrão legado; documentos criados antes de este campo existir são interpretados como HTML.
      - Allowed values: `html`, `markdown`
    - `folder_parent_id` (string, optional, nullable) — O ID da pasta pai ou null se o documento estiver no nível raiz.
    - `folder_path` (list of KnowledgeBaseFolderPathSegmentResponseModel, optional) — Os segmentos do caminho da pasta que levam a esta entidade, da raiz até a pasta pai.
  - `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) — Representação canônica do conteúdo armazenado de um documento da base de conhecimento. HTML é o padrão legado; documentos criados antes de este campo existir são interpretados como HTML.
      - Allowed values: `html`, `markdown`
    - `external_sync_info` (ExternalFileSyncInfo, optional, nullable) — Rastreia o link para o arquivo original em uma fonte externa.
    - `folder_parent_id` (string, optional, nullable) — O ID da pasta pai ou null se o documento estiver no nível raiz.
    - `folder_path` (list of KnowledgeBaseFolderPathSegmentResponseModel, optional) — Os segmentos do caminho da pasta que levam a esta entidade, da raiz até a pasta pai.
    - `is_frozen` (boolean, optional, default: false)
    - `refresh_status` (FileRefreshStatus, optional, nullable) — Estado da atualização em andamento ou da última atualização de um arquivo sincronizado externamente. Usado por clientes para exibir o progresso da sincronização e desativar nova sincronização enquanto uma atualização estiver na fila ou em processamento.
  - `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) — Representação canônica do conteúdo armazenado de um documento da base de conhecimento. HTML é o padrão legado; documentos criados antes de este campo existir são interpretados como HTML.
      - Allowed values: `html`, `markdown`
    - `folder_parent_id` (string, optional, nullable) — O ID da pasta pai ou null se o documento estiver no nível raiz.
    - `folder_path` (list of KnowledgeBaseFolderPathSegmentResponseModel, optional) — Os segmentos do caminho da pasta que levam a esta entidade, da raiz até a pasta pai.
  - `type`: `folder` (GetKnowledgeBaseFolderResponseModel)
    - `access_info` (ResourceAccessInfo, required)
    - `children_count` (integer, required)
    - `document_count` (integer, required) — Número de documentos que não são pastas em qualquer parte da subárvore desta pasta (recursivo). A contagem para após 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) — Tarefa de sincronização externa mais recente (em andamento ou concluída) desta pasta, se houver. Usada pelos clientes para exibir o progresso da sincronização.
    - `auto_sync_info` (AutoSyncInfo, optional, nullable)
    - `external_sync_info` (ExternalFolderSyncInfo, optional, nullable) — Metadados de uma pasta da base de conhecimento que espelha uma pasta de origem externa.
    - `folder_parent_id` (string, optional, nullable) — O ID da pasta pai ou null se o documento estiver no nível raiz.
    - `folder_path` (list of KnowledgeBaseFolderPathSegmentResponseModel, optional) — Os segmentos do caminho da pasta que levam a esta entidade, da raiz até a pasta pai.
    - `is_frozen` (boolean, optional, default: false)

## Errors

### 422 Unprocessable Entity Error

Erro de validação

- `detail` (list of ValidationError, optional)

## Types

### ResourceAccessInfo

- `is_creator` (boolean, required) — Indica se o usuário que faz a solicitação é o criador do agente
- `creator_name` (string, required) — Nome do criador do agente
- `creator_email` (string, required) — E-mail do criador do agente
- `role` (enum, required) — A função do usuário que faz a solicitação
  - Allowed values: `admin`, `editor`, `commenter`, `viewer`
- `anonymous_access_level_override` (enum, optional, nullable) — O nível de acesso para usuários anônimos. Se for None, o recurso não será compartilhado publicamente.
  - Allowed values: `admin`, `editor`, `commenter`, `viewer`
- `access_source` (enum, optional, nullable) — Por que o usuário solicitante tem acesso a este recurso. 'creator' = o chamador é o proprietário. 'explicit' = o chamador (ou um dos grupos do workspace dele) está listado em role_to_group_ids além do grupo everyone de todo o workspace. 'workspace_default' = o grupo everyone de todo o workspace está listado em role_to_group_ids (todos os membros não anônimos do workspace, incluindo administradores, veem este recurso). 'workspace_admin' = o chamador é administrador do workspace e a função de administrador é o *único* caminho de acesso; reservado para documentos que ninguém mais pode ver. Permite que a interface revele por que um visualizador com desvio de administrador vê um documento que não foi compartilhado explicitamente com ele.
  - 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) — Frequência mínima (em dias) para atualização do documento. O intervalo real pode ser menor, mas nunca maior.
- `auto_remove` (boolean, optional, default: false) — Se deve remover o documento se a URL ficar indisponível
- `consec_failures` (integer, optional, default: 0) — Número de falhas consecutivas de sincronização
- `next_refresh_by` (integer, optional, nullable) — Timestamp Unix da próxima sincronização agendada ou None (no caso de pastas)
- `auto_discover` (boolean, optional, default: false, deprecated) — Obsoleto. Este campo não tem mais efeito e será removido em uma versão futura.

### KnowledgeBaseFolderPathSegmentResponseModel

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

### ExternalFileSyncInfo

Rastreia o link para o arquivo original em uma fonte externa.

- `type` (enum, required) — Identificador do provedor
  - Allowed values: `google_drive`
- `source_entity_id` (string, required) — ID da entidade no sistema externo
- `integration_connection_id` (string, required) — ID da instância de conexão da integração
- `source_parent_entity_id` (string, required) — ID da pasta no sistema externo do qual este arquivo foi sincronizado
- `source_mime_type` (string, required) — Tipo MIME original no sistema externo
- `source_modified_time` (string, required) — Hora da última modificação no sistema externo
- `root_folder_id` (string, optional, nullable) — ID da pasta da base de conhecimento da raiz de sincronização, usado para consultar todas as entidades em uma árvore de sincronização

### FileRefreshStatus

Estado da atualização em andamento/da última atualização de um arquivo de base de conhecimento sincronizado externamente.

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

Metadados de uma pasta da base de conhecimento que espelha uma pasta de origem externa.

- `type` (enum, required) — Identificador do provedor
  - Allowed values: `google_drive`
- `source_entity_id` (string, required) — ID da entidade no sistema externo
- `integration_connection_id` (string, required) — ID da instância de conexão da integração
- `root_folder_id` (string, optional, nullable) — ID da pasta da base de conhecimento da raiz de sincronização. None significa que esta pasta é a raiz.
- `sync_cursor` (string, optional, nullable) — Cursor opaco para sincronização incremental, interpretado pelo provedor
- `last_sync_at` (integer, optional, nullable) — Timestamp Unix da última sincronização concluída

### ValidationError

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

### ValidationErrorLocItems

## Examples

**Request**

```json
{}
```

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

payload = {}
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.elevenlabs.io/v1/convai/knowledge-base/21m00Tcm4TlvDq8ikWAM';
const options = {method: 'PATCH', headers: {'Content-Type': 'application/json'}, body: '{}'};

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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Content-Type", "application/json")

	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::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{}"

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.patch("https://api.elevenlabs.io/v1/convai/knowledge-base/21m00Tcm4TlvDq8ikWAM")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.elevenlabs.io/v1/convai/knowledge-base/21m00Tcm4TlvDq8ikWAM', [
  'body' => '{}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.elevenlabs.io/v1/convai/knowledge-base/21m00Tcm4TlvDq8ikWAM");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

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

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