Primeiros passos

Comece a integrar um agente publicado em poucos minutos

A documentação de integração da Deep Agents foi desenhada para colocar um agente em produção com o mínimo de atrito: chave de API, chamada inicial e boas práticas de contexto.

Guia rápido para autenticar, consultar o agente e fazer a primeira execução.

5 min de leitura

Configure

Defina autenticação, contexto e payloads para integrar agentes publicados com segurança.

Deploy

Publique o agente em portais, CRMs, produtos internos ou middleware próprio sem depender da UI padrão.

Monitor

Acompanhe resposta, tokens, versão publicada e rastros de execução para evoluir a operação.

Autenticação

Todos os endpoints de agentes publicados exigem o header X-Agent-API-Key. Gere essa chave na tela de publicação do agente e trate-a como uma credencial de produção.

Header obrigatório

HTTP

X-Agent-API-Key: dda_live_...

Recomendamos armazenar a chave em um cofre de segredos e nunca expô-la em código cliente.

1. Obter metadados do agente

Use esse endpoint para validar a publicação, descobrir nome, versão ativa, provedor e ferramentas habilitadas antes de começar a execução das conversas.

GET

Bash

GET https://api.agents.deepdive4ai.com/api/agent-api/agents/{agentId}

curl -X GET "https://api.agents.deepdive4ai.com/api/agent-api/agents/SEU_AGENT_ID" \
  -H "X-Agent-API-Key: SUA_CHAVE_DE_API"

2. Executar o agente

A execução recebe a mensagem atual e pode incluir um histórico prévio. Isso permite manter continuidade entre chamadas sem depender da interface pública ou de um iframe.

POST

Bash / JSON

POST https://api.agents.deepdive4ai.com/api/agent-api/agents/{agentId}/execute

{
  "conversationId": "cliente-123",
  "message": "Quero um resumo do contrato.",
  "history": [
    { "role": "user", "content": "Olá" },
    { "role": "assistant", "content": "Como posso ajudar?" }
  ],
  "visualAttachments": []
}

curl -X POST "https://api.agents.deepdive4ai.com/api/agent-api/agents/SEU_AGENT_ID/execute" \
  -H "Content-Type: application/json" \
  -H "X-Agent-API-Key: SUA_CHAVE_DE_API" \
  -d '{
    "conversationId": "cliente-123",
    "message": "Quero um resumo do contrato.",
    "history": [],
    "visualAttachments": []
  }'