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:

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. Para autenticar suas solicitações, inclua sua chave de API no cabeçalho Authorization:

Autorização: Portador SUA_CHAVE_DE_API

Header de workspace

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

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.

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
`/agents/{id}`	GET	Obter um agente específico	Obter Agente
`/agents/{id}/execute`	POST	Executar um agente	Executar Agente
`/agent-responses/{id}`	GET	Obter resposta da execução do agente	Obter resposta do agente

Arquivos do Agente

Ponto final	Método	Descrição	Documentação
`/agents/{agentId}/files`	GET	Listar arquivos do agente	Listar Arquivos do Agente
`/agents/{agentId}/files`	POST	Vincular arquivos ao agente	Vincular arquivos ao agente
`/agents/{agentId}/files/{fileId}`	EXCLUIR	Excluir arquivo do agente	Excluir Arquivo do Agente

Webhooks de Agentes

Ponto final	Método	Descrição	Documentação
`/agents/{id}/webhooks`	GET	Listar webhooks de agentes	Listar Webhooks de Agentes
`/agents/{id}/webhooks`	POST	Criar webhook de agente	Criar Webhook de Agente

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

Mission Control

Ponto final	Método	Descrição	Documentação
`/mission-control/usage`	GET	Consumo de IA, execuções e adoção do workspace	Uso do Mission Control

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

Memórias

Ponto final	Método	Descrição	Documentação
`/memories`	GET	Listar todas as memórias	Listar memórias
`/memories`	POST	Criar uma memória	Criar Memória
`/memories/{memoryId}`	PATCH	Atualizar uma memória	Atualizar Memória
`/memories/{memoryId}`	EXCLUIR	Excluir uma memória	Excluir memória

Coleções de Memórias

Ponto final	Método	Descrição	Documentação
`/memory-collections`	GET	Listar todas as coleções	Listar Coleções
`/memory-collections`	POST	Criar uma coleção	Criar Coleção
`/memory-collections/{collection_id}`	PUT	Atualizar uma coleção	Atualizar Coleção
`/memory-collections/{collection_id}`	EXCLUIR	Excluir uma coleção	Excluir Coleção

Arquivos

Ponto final	Método	Descrição	Documentação
`/files`	GET	Listar todos os arquivos	Listar Arquivos
`/files`	POST	Enviar um arquivo	Enviar Arquivo
`/files/{fileId}`	GET	Obter detalhes do arquivo	Obter Arquivo
`/files/{fileId}`	EXCLUIR	Excluir um arquivo	Excluir Arquivo
`/files/{fileId}/process`	POST	Processar um arquivo	Processar Arquivo

Webhooks

Ponto final	Método	Descrição	Documentação
`/webhooks`	GET	Listar todos os webhooks	Listar Webhooks
`/webhooks/{id}`	EXCLUIR	Excluir um webhook	Excluir Webhook

Versões de Agente

Endpoint	Método	Descrição	Documentação
`/agents/{id}/versions`	GET	Listar versões do agente	Listar versões do agente
`/agents/{id}/versions/{version_number}`	GET	Obter versão do agente	Obter versão do agente
`/agents/{id}/versions/{version_number}/rollback`	POST	Reverter versão do agente	Reverter versão do agente

Agendamentos de Agentes

Endpoint	Método	Descrição	Documentação
`/schedulers`	GET	Listar todos os agendamentos	Listar todos os agendamentos
`/agents/{agentId}/schedulers`	GET	Listar agendamentos do agente	Listar agendamentos do agente
`/agents/{agentId}/schedulers`	POST	Criar agendamento	Criar agendamento
`/agents/{agentId}/schedulers/{schedulerId}`	GET	Obter agendamento	Obter agendamento
`/agents/{agentId}/schedulers/{schedulerId}`	PUT	Atualizar agendamento	Atualizar agendamento
`/agents/{agentId}/schedulers/{schedulerId}`	DELETE	Excluir agendamento	Excluir agendamento
`/agents/{agentId}/schedulers/by-root-execution/{agentRootIdExecution}`	DELETE	Excluir agendamentos por execução raiz	Excluir agendamentos por execução raiz

Artifacts

Endpoint	Método	Descrição	Documentação
`/artifacts`	GET	Listar artifacts	Listar artifacts
`/artifacts`	POST	Criar artifact	Criar artifact
`/artifacts/{universal_id}`	GET	Obter artifact	Obter artifact
`/artifacts/{universal_id}`	PATCH	Renomear artifact	Renomear artifact
`/artifacts/{universal_id}`	DELETE	Excluir artifact	Excluir artifact
`/artifacts/{universal_id}/edit`	POST	Editar artifact	Editar artifact
`/artifacts/{universal_id}/publish`	POST	Publicar versão do artifact	Publicar versão do artifact
`/artifacts/{universal_id}/publish`	DELETE	Despublicar artifact	Despublicar artifact
`/artifacts/{universal_id}/restore`	POST	Restaurar versão do artifact	Restaurar versão do artifact
`/artifacts/{universal_id}/share`	POST	Compartilhar ou descompartilhar artifact	Compartilhar ou descompartilhar artifact
`/artifacts/{universal_id}/versions`	GET	Listar versões do artifact	Listar versões do artifact
`/artifacts/{universal_id}/versions/{version}`	DELETE	Excluir versão do artifact	Excluir versão do artifact
`/artifact-templates`	GET	Listar modelos de artifact	Listar modelos de artifact

Importação de Memórias

Endpoint	Método	Descrição	Documentação
`/memory-import`	POST	Importar memórias de texto	Importar memórias de texto
`/memory-import/{id}`	GET	Obter status da importação de memórias	Obter status da importação de memórias

Conta

Endpoint	Método	Descrição	Documentação
`/me`	GET	Obter usuário atual	Obter usuário atual

Respostas de Agentes

Endpoint	Método	Descrição	Documentação
`/agent-responses`	GET	Listar respostas de agentes	Listar respostas de agentes

Referências e Visibilidade de Arquivos

Endpoint	Método	Descrição	Documentação
`/files/resolve`	POST	Resolver referência de arquivo	Resolver referência de arquivo
`/files/{fileId}/visibility`	PATCH	Atualizar visibilidade do arquivo	Atualizar visibilidade do arquivo

IDs de Coleções de Memórias

Endpoint	Método	Descrição	Documentação
`/memory-collections/ids`	GET	Listar IDs das coleções	Listar IDs das coleções

Digital Employees

Endpoint	Método	Descrição	Documentação
`/digital-employees/capabilities`	GET	Verificar Capacidades	Verificar Capacidades
`/digital-employees`	GET	Listar Digital Employees	Listar Digital Employees
`/digital-employees/standalone`	POST	Criar Employee Standalone	Criar Employee Standalone
`/digital-employees/agents/{agentId}`	POST	Criar Employee a partir de Agente	Criar Employee a partir de Agente
`/digital-employees/{employeeId}`	GET	Obter Digital Employee	Obter Digital Employee
`/digital-employees/{employeeId}`	PUT	Atualizar Digital Employee	Atualizar Digital Employee
`/digital-employees/{employeeId}/duplicate`	POST	Duplicar Digital Employee	Duplicar Digital Employee
`/digital-employees/{employeeId}`	DELETE	Deletar Digital Employee	Deletar Digital Employee
`/digital-employees/schedule-preview`	POST	Prévia de Agendamento	Prévia de Agendamento
`/digital-employees/{employeeId}/invoke`	POST	Invocar Digital Employee	Invocar Digital Employee
`/digital-employees/{employeeId}/runs/{runId}/retry`	POST	Retentar Execução	Retentar Execução
`/digital-employees/{employeeId}/runs`	GET	Listar Execuções	Listar Execuções
`/digital-employees/{employeeId}/runs/{runId}`	GET	Obter Execução	Obter Execução
`/digital-employees/{employeeId}/runs/{runId}/output`	GET	Saída da Execução	Saída da Execução
`/digital-employees/{employeeId}/runs/{runId}/stream`	GET	Transmitir Execução	Transmitir Execução
`/digital-employees/{employeeId}/pause`	POST	Pausar Digital Employee	Pausar Digital Employee
`/digital-employees/{employeeId}/resume`	POST	Retomar Digital Employee	Retomar Digital Employee
`/digital-employees/{employeeId}/rollback-options`	GET	Opções de Rollback	Opções de Rollback
`/digital-employees/{employeeId}/rollback`	POST	Rollback de Digital Employee	Rollback de Digital Employee
`/digital-employees/{employeeId}/reparent`	POST	Reatribuir Parent	Reatribuir Parent
`/digital-employees/{employeeId}/detach`	POST	Desanexar Digital Employee	Desanexar Digital Employee
`/digital-employees/{employeeId}/runs/summary`	GET	Resumo das Execuções	Resumo das Execuções
`/digital-employees/{employeeId}/activity`	GET	Log de Atividade	Log de Atividade
`/digital-employees/{employeeId}/files`	GET	Arquivos do Employee	Arquivos do Employee
`/digital-employees/{employeeId}/goal`	PUT	Atualizar Objetivo	Atualizar Objetivo
`/digital-employees/{employeeId}/approve`	POST	Aprovar Contratação	Aprovar Contratação
`/digital-employees/{employeeId}/reject`	POST	Rejeitar Contratação	Rejeitar Contratação
`/digital-employees/avatar-upload`	POST	Upload de Avatar	Upload de Avatar
`/digital-employees/template-packs/agents/{agentId}`	GET	Exportar Template Pack	Exportar Template Pack
`/digital-employees/template-packs/preview-import`	POST	Prévia de Importação de Template	Prévia de Importação de Template
`/digital-employees/template-packs/import`	POST	Importar Template Pack	Importar Template Pack

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:

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.

Guia da API

Referência da API

Integrações

Protocolo de Contexto de Modelo (MCP)

URL base

Autenticação

Header de workspace

Pontos de extremidade da API

Agentes

Arquivos do Agente

Webhooks de Agentes

Workspaces

Mission Control

Eventos de auditoria

Memórias

Coleções de Memórias

Arquivos

Webhooks

Versões de Agente

Agendamentos de Agentes

Artifacts

Importação de Memórias

Conta

Respostas de Agentes

Referências e Visibilidade de Arquivos

IDs de Coleções de Memórias

Digital Employees

Formato de Solicitação

Formato de Resposta

​URL base

​Autenticação

​Header de workspace

​Pontos de extremidade da API

​Agentes

​Arquivos do Agente

​Webhooks de Agentes

​Workspaces

​Mission Control

​Eventos de auditoria

​Memórias

​Coleções de Memórias

​Arquivos

​Webhooks

​Versões de Agente

​Agendamentos de Agentes

​Artifacts

​Importação de Memórias

​Conta

​Respostas de Agentes

​Referências e Visibilidade de Arquivos

​IDs de Coleções de Memórias

​Digital Employees

​Formato de Solicitação

​Formato de Resposta

URL base

Autenticação

Header de workspace

Pontos de extremidade da API

Agentes

Arquivos do Agente

Webhooks de Agentes

Workspaces

Mission Control

Eventos de auditoria

Memórias

Coleções de Memórias

Arquivos

Webhooks

Versões de Agente

Agendamentos de Agentes

Artifacts

Importação de Memórias

Conta

Respostas de Agentes

Referências e Visibilidade de Arquivos

IDs de Coleções de Memórias

Digital Employees

Formato de Solicitação

Formato de Resposta