> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tess.im/llms.txt
> Use this file to discover all available pages before exploring further.

# Visão Geral

Bem-vindo à documentação da API da Tess AI! Este guia ajudará você a começar a usar nossa API e a entender como integrar os poderosos recursos da Tess AI em seus aplicativos.

### **URL base**

Todas as solicitações à API devem ser feitas para a seguinte URL base:

```texto theme={null}
https://api.tess.im
```

## **Autenticação**

Todas as solicitações de API exigem autenticação usando uma chave de API. Você pode obter sua chave de API no [Painel de Controle do Tess AI](https://tess.im/dashboard).

Para autenticar suas solicitações, inclua sua chave de API no cabeçalho `Authorization`:

```texto theme={null}
Autorização: Portador SUA_CHAVE_DE_API
```

## **Header de workspace**

Requisições autenticadas da API devem incluir o header de contexto do workspace:

```texto theme={null}
x-workspace-id: YOUR_WORKSPACE_ID
```

**Obrigatório a partir de 01/09/2026** para execução de agentes e demais endpoints autenticados da API. Até lá, se omitido, a API usa o workspace selecionado do usuário (deprecated). Após a data, ausência → **422**. Veja [Errors](/pt/errors).

## **Pontos de extremidade da API**

A API Tess AI fornece as seguintes categorias principais de endpoints:

#### **Agentes**

| **Ponto final**         | **Método** | **Descrição**                        | **Documentação**                                                   |
| :---------------------- | :--------- | :----------------------------------- | :----------------------------------------------------------------- |
| `/agents`               | GET        | Listar todos os agentes              | [Listar Agentes](https://docs.tess.im/pt/list-agents)              |
| `/agents/{id}`          | GET        | Obter um agente específico           | [Obter Agente](https://docs.tess.im/pt/get-agent)                  |
| `/agents/{id}/execute`  | POST       | Executar um agente                   | [Executar Agente](https://docs.tess.im/pt/execute-agent)           |
| `/agent-responses/{id}` | GET        | Obter resposta da execução do agente | [Obter resposta do agente](https://docs.tess.im/pt/agent-response) |

#### **Arquivos do Agente**

| **Ponto final**                    | **Método** | **Descrição**               | **Documentação**                                                       |
| :--------------------------------- | :--------- | :-------------------------- | :--------------------------------------------------------------------- |
| `/agents/{agentId}/files`          | GET        | Listar arquivos do agente   | [Listar Arquivos do Agente](https://docs.tess.im/pt/list-agent-files)  |
| `/agents/{agentId}/files`          | POST       | Vincular arquivos ao agente | [Vincular arquivos ao agente](https://docs.tess.im/pt/link-files)      |
| `/agents/{agentId}/files/{fileId}` | EXCLUIR    | Excluir arquivo do agente   | [Excluir Arquivo do Agente](https://docs.tess.im/en/delete-agent-file) |

#### **Webhooks de Agentes**

| **Ponto final**         | **Método** | **Descrição**              | **Documentação**                                                          |
| :---------------------- | :--------- | :------------------------- | :------------------------------------------------------------------------ |
| `/agents/{id}/webhooks` | GET        | Listar webhooks de agentes | [Listar Webhooks de Agentes](https://docs.tess.im/pt/list-agent-webhooks) |
| `/agents/{id}/webhooks` | POST       | Criar webhook de agente    | [Criar Webhook de Agente](https://docs.tess.im/pt/create-agent-webhook)   |

#### **Workspaces**

| **Ponto final**     | **Método** | **Descrição**                                        | **Documentação**                                            |
| :------------------ | :--------- | :--------------------------------------------------- | :---------------------------------------------------------- |
| `/workspaces/usage` | GET        | Histórico de execuções de agentes (uso do workspace) | [Uso do workspace](https://docs.tess.im/pt/workspace-usage) |

#### **Eventos de auditoria**

| **Ponto final** | **Método** | **Descrição**                                        | **Documentação**                                             |
| :-------------- | :--------- | :--------------------------------------------------- | :----------------------------------------------------------- |
| `/audit-events` | GET        | Consulta eventos de auditoria do workspace para SIEM | [Eventos de auditoria](https://docs.tess.im/pt/audit-events) |

#### **Memórias**

| **Ponto final**        | **Método** | **Descrição**            | **Documentação**                                           |
| :--------------------- | :--------- | :----------------------- | :--------------------------------------------------------- |
| `/memories`            | GET        | Listar todas as memórias | [Listar memórias](https://docs.tess.im/pt/list-memories)   |
| `/memories`            | POST       | Criar uma memória        | [Criar Memória](https://docs.tess.im/pt/create-memory)     |
| `/memories/{memoryId}` | PATCH      | Atualizar uma memória    | [Atualizar Memória](https://docs.tess.im/pt/update-memory) |
| `/memories/{memoryId}` | EXCLUIR    | Excluir uma memória      | [Excluir memória](https://docs.tess.im/pt/delete-memory)   |

#### **Coleções de Memórias**

| **Ponto final**                       | **Método** | **Descrição**            | **Documentação**                                               |
| :------------------------------------ | :--------- | :----------------------- | :------------------------------------------------------------- |
| `/memory-collections`                 | GET        | Listar todas as coleções | [Listar Coleções](https://docs.tess.im/pt/list-collections)    |
| `/memory-collections`                 | POST       | Criar uma coleção        | [Criar Coleção](https://docs.tess.im/pt/create-collection)     |
| `/memory-collections/{collection_id}` | PUT        | Atualizar uma coleção    | [Atualizar Coleção](https://docs.tess.im/pt/update-collection) |
| `/memory-collections/{collection_id}` | EXCLUIR    | Excluir uma coleção      | [Excluir Coleção](https://docs.tess.im/pt/delete-collection)   |

#### **Arquivos**

| **Ponto final**           | **Método** | **Descrição**             | **Documentação**                                          |
| :------------------------ | :--------- | :------------------------ | :-------------------------------------------------------- |
| `/files`                  | GET        | Listar todos os arquivos  | [Listar Arquivos](https://docs.tess.im/pt/list-files)     |
| `/files`                  | POST       | Enviar um arquivo         | [Enviar Arquivo](https://docs.tess.im/pt/upload-file)     |
| `/files/{fileId}`         | GET        | Obter detalhes do arquivo | [Obter Arquivo](https://docs.tess.im/pt/get-file)         |
| `/files/{fileId}`         | EXCLUIR    | Excluir um arquivo        | [Excluir Arquivo](https://docs.tess.im/pt/delete-file)    |
| `/files/{fileId}/process` | POST       | Processar um arquivo      | [Processar Arquivo](https://docs.tess.im/en/process-file) |

#### **Webhooks**

| **Ponto final**  | **Método** | **Descrição**            | **Documentação**                                          |
| :--------------- | :--------- | :----------------------- | :-------------------------------------------------------- |
| `/webhooks`      | GET        | Listar todos os webhooks | [Listar Webhooks](https://docs.tess.im/pt/list-webhooks)  |
| `/webhooks/{id}` | EXCLUIR    | Excluir um webhook       | [Excluir Webhook](https://docs.tess.im/pt/delete-webhook) |

## **Formato de Solicitação**

A maioria dos endpoints de API aceita corpos de requisição codificados em JSON. Certifique-se de incluir o seguinte cabeçalho em suas requisições:

```texto theme={null}
Tipo de conteúdo: application/json
```

## **Formato de Resposta**

Todas as respostas da API são retornadas em formato JSON. Uma resposta bem-sucedida normalmente terá um código de status HTTP `2xx` e conterá os dados solicitados. Respostas de erro terão um código de status `4xx` ou `5xx` e incluirão uma mensagem de erro.
