API de Compound
Desarrolle con Compound
La API REST de Compound ofrece a su software los mismos agentes que utilizan sus analistas. Cree un agente para cada uno de sus usuarios, envíele archivos y preguntas, y siga su trabajo en directo a medida que avanza.
Qué puede hacer la API
Todo lo que hace la CLI de Compound está disponible mediante HTTPS, con los mismos permisos y los mismos resultados.
Agentes
Cree tantos agentes como necesite, etiquete cada uno con su propio ID externo y enumérelos, modifíquelos o elimínelos.
Mensajes y eventos en directo
Envíe un mensaje a un agente y reciba en continuo sus respuestas, los cambios en sus tareas, sus propuestas y cada operación que ejecuta como server-sent events.
Tareas y propuestas
Haga seguimiento de las tareas en las que trabaja un agente y apruebe o rechace los cambios que propone.
Archivos
Cargue documentos de origen, descargue los archivos de Excel, Word, PowerPoint y PDF que genera un agente y consulte su historial de versiones.
Uso compartido y proyectos
Comparta el Drive de un agente con las personas de su equipo y agrupe el trabajo relacionado en proyectos.
Programaciones
Ejecute un agente de forma programada, por ejemplo una actualización semanal de la cartera o un resumen matutino de noticias.
Bandeja de entrada y comentarios
Lea la bandeja de entrada de un agente y los hilos de comentarios que las personas dejan en sus archivos.
Listas de empresas seguidas
Elija las empresas cotizadas que sigue un agente para que tenga en cuenta sus presentaciones regulatorias y sus noticias.
Consumo
Consulte los créditos de su plan y lo que ha gastado en cada agente.
Su primera solicitud
Tres llamadas cubren el ciclo básico: crear un agente para uno de sus usuarios, enviarle un mensaje y seguir su progreso en directo.
1. Exporte la clave de API que emitimos para su organización, en lugar del marcador.
export COMPOUND_API_KEY="<your-api-key>"2. Cree un agente y etiquételo con el ID que su sistema utiliza para ese usuario.
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. Envíe un mensaje al 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. Siga los eventos del agente en continuo mientras trabaja.
curl -N https://ws.getcompound.ai/v1/agents/$AGENT_ID/events \ -H "Authorization: Bearer $COMPOUND_API_KEY"
Cómo funciona el acceso
El acceso a la API no es de autoservicio. Configuramos cada organización con nuestro equipo para que la cuenta, la facturación y los límites se ajusten al uso que va a hacer.
01
Solicite una demo
Cuéntenos qué desea desarrollar y cuántas personas o sistemas llamarán a la API.
02
Activamos su organización
Nuestro equipo crea una cuenta de API para su equipo o empresa y acuerda con usted los límites y la facturación.
03
Recibe sus claves de API
Emitimos claves para su organización. Envíelas en el encabezado Authorization como token Bearer.
Las claves de API pertenecen a su organización, no a una persona. Una sola clave puede crear un agente para cada usuario de su empresa y sigue funcionando cuando alguien se incorpora o se marcha.
Seguridad
Claves almacenadas con hash
Solo almacenamos un hash de cada clave. La clave completa se muestra una única vez, cuando se emite.
Revocable en cualquier momento
Solicítenos revocar una clave y todas las solicitudes que la usen se rechazarán de inmediato. Pida una clave nueva antes de rotar.
Con límite de frecuencia
Cada organización tiene límites de solicitudes, de modo que un script descontrolado no ralentice el resto de su trabajo.
Sus datos siguen siendo suyos
Una clave de API solo accede a los agentes y archivos de su propia organización. Se aplican los mismos controles de seguridad que en la aplicación de Compound.
Especificación OpenAPI
La especificación describe todos los endpoints y funciona con cualquier herramienta OpenAPI o generador de clientes.
Preguntas frecuentes
No. Solicite una demo y nuestro equipo activará una cuenta de API para su organización y le entregará sus claves.
Tantos como necesite su organización. Una configuración habitual es un agente por persona de su empresa, todos creados con la misma clave de organización.
Indique un ID externo al crear un agente y filtre por él al enumerar los agentes. Compound almacena el valor y nunca lo interpreta.
La CLI está construida sobre la misma API, así que todo lo que puede hacer desde la CLI también puede hacerlo mediante HTTPS. Las personas pueden seguir iniciando sesión en la CLI con su propia cuenta de Compound.
Abra el flujo de eventos de un agente. Primero envía una instantánea del estado del agente y luego un server-sent event por cada mensaje nuevo, cambio de tarea, propuesta y operación. Vuelva a conectarse con el último cursor que leyó para continuar donde lo dejó.
El uso de la API consume los créditos de Compound de su organización. Acordamos con usted los precios y los límites al activar su cuenta.
Hable con nosotros sobre la API
Cuéntenos qué desea desarrollar. Configuraremos su organización y le entregaremos sus claves.