A uma chamada de distância

Autentique-se com uma chave e chame qualquer endpoint

Emita uma chave de API com escopo limitado pelo seu painel, envie-a como token bearer e todos os endpoints sob /api/developer/v1 ficam à sua disposição: liste agentes, envie um documento ou execute uma consulta.

Ler a documentação da API
Requisição de exemplo
curl https://cuneiform.chat/api/developer/v1/agents \
  -H "Authorization: Bearer cuk_live_xxxxxxxxxxxxxxxxxxxx"

API para desenvolvedores

Construa sobre o Cuneiform Chat a partir do seu próprio código

Uma API REST pública e autenticada por chave que permite ao seu código fazer o que o painel faz: enviar conhecimento, gerenciar seus agentes de IA e consultá-los de qualquer lugar. Uma única chave bearer, JSON previsível e uma referência da qual você pode copiar.

O que você pode construir com a API

  • Envie conhecimento de forma programática

    Envie documentos para a base de conhecimento de um agente direto do seu código ou do seu pipeline. Os arquivos são processados, divididos em trechos, incorporados e tornados pesquisáveis: o mesmo stack RAG que o painel usa, acionado por uma chamada de API.

  • Gerencie agentes como código

    Crie, liste, atualize e inspecione seus agentes de IA pela API. Conecte a configuração dos agentes ao seu próprio provisionamento ou CI para que um novo agente seja uma etapa de deploy, e não um clique no painel.

  • Consulte um agente de qualquer lugar

    Envie uma pergunta a qualquer agente e receba uma resposta fundamentada, com a mesma recuperação e o mesmo raciocínio que seus canais usam. Incorpore em um aplicativo, em uma tarefa de backend ou em outro produto.

  • Chaves de API com escopo e revogáveis

    Gere chaves apenas com os escopos de que cada carga de trabalho precisa e revogue-as no instante em que vazarem. As chaves têm o prefixo cuk_live_ e são exibidas uma única vez: privilégio mínimo, por design.

  • Erros e limites de uso previsíveis

    Toda resposta é JSON com um formato estável, códigos de erro consistentes e cabeçalhos claros de limite de uso, para que seu cliente possa tentar de novo, aplicar back-off e expor falhas sem adivinhação.

  • Uma referência da qual você pode copiar

    Uma referência completa e publicada cobre a autenticação, as convenções, os erros, os limites de uso e todos os endpoints dos três domínios, com exemplos de requisição e resposta prontos para colar.

Da chave à primeira resposta

Cinco passos de um terminal vazio até uma integração no ar.

  1. Pegue uma chave

    Abra o console de desenvolvedores no seu painel e emita uma chave de API, escolhendo os escopos de que a integração precisa. Copie uma única vez: ela começa com cuk_live_.

  2. Autentique-se

    Envie a chave como Authorization: Bearer em toda requisição (o cabeçalho X-API-Key é um alias documentado). Sem dança de OAuth, sem sessão para renovar.

  3. Chame um endpoint

    Acesse qualquer caminho sob /api/developer/v1: envie para Conhecimento, gerencie Agentes ou execute uma Consulta de agente. Mesma URL base, mesma autenticação, três domínios.

  4. Trate a resposta

    Faça o parse do corpo JSON, leia os cabeçalhos de limite de uso e ramifique pelo código de erro quando algo der errado. O formato é estável em todos os endpoints.

  5. Coloque em produção e escale

    Passe de um teste com curl para produção: rotacione chaves, defina escopos por carga de trabalho e deixe os limites de uso documentados orientarem as tentativas e a concorrência do seu cliente.

Casos de uso

O que as equipes constroem com a API

  • Sincronize conhecimento dos seus sistemas

    Configure uma tarefa noturna ou um webhook para enviar novos documentos, artigos da central de ajuda ou especificações de produto à base de conhecimento de um agente, para que as respostas fiquem sempre atualizadas sem ninguém tocar no painel.

  • Incorpore um agente no seu próprio produto

    Chame o endpoint de consulta a partir do seu aplicativo ou backend para adicionar um assistente de IA fundamentado a uma superfície para a qual não oferecemos um canal: seu aplicativo móvel, uma ferramenta interna ou um widget personalizado.

  • Provisione agentes em CI/CD

    Crie e configure agentes como parte de um pipeline de deploy, de modo que subir um novo ambiente ou um novo tenant de cliente já inclua o agente de IA como código, e não como uma etapa manual de configuração.

  • Automatize fluxos de retaguarda

    Faça um script pedir a um agente que resuma, classifique ou responda sobre sua base de conhecimento em uma agenda, e direcione o resultado para onde sua equipe já trabalha.

  • Alimente ferramentas e painéis internos

    Traga as respostas dos agentes para um bot do Slack, um painel de operações ou um console de suporte que sejam seus: uma única chave bearer e uma resposta JSON é tudo de que a integração precisa.

Conheça outros recursos