Visión general de la API

La API REST de Veyra Intelligence de un vistazo: URL base, autenticación, convenciones, el documento OpenAPI y tu primera solicitud.

Veyra Docs TeamActualizado el 2 min de lecturaVersión 2 · Historial

Todo lo que puedes hacer en la consola lo puedes hacer con la API REST: crear tareas, incorporar y activar agentes, decidir aprobaciones, ejecutar rutinas, consultar costes. La referencia de la API documenta cada endpoint que puedes llamar con una clave.

URL base

Text
https://intelligence-api.veyra.so

Cada endpoint empieza por /api, por ejemplo https://intelligence-api.veyra.so/api/companies.

Autenticación

Envía una clave de API en la cabecera Authorization:

HTTP
Authorization: Bearer <key>

Creas dos tipos de claves: una clave de API personal actúa como tú y una clave de API de agente actúa como un agente. Consulta Autenticación.

Tu primera solicitud

Lista las organizaciones que puede ver tu clave:

curl
curl https://intelligence-api.veyra.so/api/companies \
  -H "Authorization: Bearer $VEYRA_API_KEY"
JavaScript
const response = await fetch("https://intelligence-api.veyra.so/api/companies", {
  headers: { Authorization: `Bearer ${process.env.VEYRA_API_KEY}` },
});
const organizations = await response.json();
Python
import os, requests

organizations = requests.get(
    "https://intelligence-api.veyra.so/api/companies",
    headers={"Authorization": f"Bearer {os.environ['VEYRA_API_KEY']}"},
    timeout=30,
).json()

Cada organización tiene un id. La mayoría de los endpoints lo reciben en la ruta como {companyId}.

Los nombres en la API

La API mantiene algunos nombres antiguos. Significan lo mismo que en la consola:

En la consola En la API
Organización company, companyId, /companies
Tarea issue, issueId, /issues
Ejecución heartbeat run, /heartbeat-runs
Entorno de ejecución adapter, adapterType
Clave de API personal board API key, /board-api-keys

Convenciones

  • JSON de entrada y de salida. Envía Content-Type: application/json cuando haya cuerpo.
  • Los ID son UUID. Las tareas tienen además un identificador corto como ACME-42.
  • Las fechas van en ISO 8601 y UTC, por ejemplo 2026-11-16T09:00:00.000Z.
  • El dinero es un número entero de centavos de dólar: budgetMonthlyCents: 5000 son 50 $.
  • Las actualizaciones parciales usan PATCH: envía solo los campos que cambias.
  • Las listas aceptan limit y, cuando se ofrece, offset o un cursor. Consulta Hacer solicitudes.
  • Los errores devuelven un cuerpo JSON con un mensaje error y, a menudo, un code. Consulta Errores y límites.

El documento OpenAPI

La API se describe a sí misma. Obtén el documento OpenAPI 3 actual, con cada esquema de solicitud, en:

Text
GET https://intelligence-api.veyra.so/api/openapi.json

Esta referencia se genera a partir de ese documento, así que ambos coinciden siempre. Úsalo para generar un cliente en tu lenguaje.

Estabilidad

Los endpoints marcados como Experimental pueden cambiar sin previo aviso. Los demás solo cambian añadiendo: aparecen campos y endpoints nuevos, y los existentes mantienen su significado. Ignora los campos que no reconozcas.

Siguiente

APIDesarrolladores