API da Compound
Desenvolva com a Compound
A API REST da Compound oferece ao seu software os mesmos agentes que seus analistas usam. Crie um agente para cada um de seus usuários, envie arquivos e perguntas e acompanhe o trabalho dele em tempo real.
O que a API pode fazer
Tudo o que a CLI da Compound faz está disponível por HTTPS, com as mesmas permissões e os mesmos resultados.
Agentes
Crie quantos agentes precisar, identifique cada um com seu próprio ID externo e liste, altere ou exclua os agentes.
Mensagens e eventos em tempo real
Envie uma mensagem a um agente e receba continuamente as respostas, as mudanças nas tarefas, as propostas e cada operação que ele executa como server-sent events.
Tarefas e propostas
Acompanhe as tarefas em que um agente está trabalhando e aprove ou rejeite as alterações que ele propõe.
Arquivos
Envie documentos de origem, baixe os arquivos Excel, Word, PowerPoint e PDF gerados por um agente e consulte o histórico de versões deles.
Compartilhamento e projetos
Compartilhe o Drive de um agente com as pessoas da sua equipe e agrupe trabalhos relacionados em projetos.
Agendamentos
Execute um agente de forma agendada, como uma atualização semanal da carteira ou um resumo matinal de notícias.
Caixa de entrada e comentários
Leia a caixa de entrada de um agente e os tópicos de comentários que as pessoas deixam nos arquivos dele.
Listas de empresas acompanhadas
Escolha as empresas de capital aberto que um agente acompanha para que ele considere os documentos e as notícias delas.
Uso
Consulte os créditos do seu plano e quanto você gastou com cada agente.
Sua primeira requisição
Três chamadas cobrem o ciclo principal: criar um agente para um de seus usuários, enviar uma mensagem a ele e acompanhar o progresso em tempo real.
1. Exporte a chave de API que emitimos para sua organização, no lugar do marcador.
export COMPOUND_API_KEY="<your-api-key>"2. Crie um agente e identifique-o com o ID que seu sistema usa para esse usuário.
AGENT_ID=$(curl -X POST https://ws.getcompound.ai/v1/agents \ -H "Authorization: Bearer $COMPOUND_API_KEY" \ -H "Content-Type: application/json" \ -d '{"name":"Research agent","external_id":"user-4821"}' | jq -r .id)3. Envie uma mensagem ao agente.
curl -X POST https://ws.getcompound.ai/v1/agents/$AGENT_ID/messages \ -H "Authorization: Bearer $COMPOUND_API_KEY" \ -H "Content-Type: application/json" \ -d '{"text":"Summarize the latest 10-K and build a three-statement model."}'4. Acompanhe os eventos do agente continuamente enquanto ele trabalha.
curl -N https://ws.getcompound.ai/v1/agents/$AGENT_ID/events \ -H "Authorization: Bearer $COMPOUND_API_KEY"
Como funciona o acesso
O acesso à API não é por autoatendimento. Configuramos cada organização com nossa equipe para que a conta, o faturamento e os limites se ajustem ao uso que você fará.
01
Agende uma demo
Conte o que você quer desenvolver e quantas pessoas ou sistemas chamarão a API.
02
Ativamos sua organização
Nossa equipe cria uma conta de API para sua equipe ou empresa e acerta com você os limites e o faturamento.
03
Você recebe suas chaves de API
Emitimos chaves para sua organização. Envie-as no cabeçalho Authorization como token Bearer.
As chaves de API pertencem à sua organização, não a uma pessoa. Uma única chave pode criar um agente para cada usuário da sua empresa e continua funcionando quando pessoas entram ou saem.
Segurança
Chaves armazenadas com hash
Armazenamos apenas o hash de cada chave. A chave completa é exibida uma única vez, no momento da emissão.
Revogável a qualquer momento
Peça-nos para revogar uma chave e todas as requisições que a usarem serão rejeitadas imediatamente. Emita uma nova chave antes de fazer a rotação.
Com limite de taxa
Cada organização tem limites de requisições, para que um script descontrolado não deixe o restante do seu trabalho lento.
Seus dados continuam seus
Uma chave de API acessa apenas os agentes e arquivos da própria organização. Aplicam-se os mesmos controles de segurança do aplicativo da Compound.
Especificação OpenAPI
A especificação descreve todos os endpoints e funciona com qualquer ferramenta OpenAPI ou gerador de clientes.
Perguntas frequentes
Não. Agende uma demo e nossa equipe ativará uma conta de API para sua organização e emitirá as chaves.
Quantos sua organização precisar. Uma configuração comum é um agente por pessoa da sua empresa, todos criados com a mesma chave da organização.
Informe um ID externo ao criar um agente e filtre por ele ao listar os agentes. A Compound armazena o valor e nunca o interpreta.
A CLI é construída sobre a mesma API, portanto tudo o que você faz na CLI também pode ser feito por HTTPS. As pessoas podem continuar entrando na CLI com a própria conta da Compound.
Abra o fluxo de eventos de um agente. Primeiro ele envia um snapshot do estado do agente e depois um server-sent event para cada nova mensagem, mudança de tarefa, proposta e operação. Reconecte com o último cursor lido para continuar de onde parou.
O uso da API consome os créditos da Compound da sua organização. Acertamos com você os preços e os limites quando ativamos sua conta.
Fale conosco sobre a API
Conte o que você quer desenvolver. Configuraremos sua organização e entregaremos suas chaves.