API overview

The Veyra Intelligence REST API at a glance - base URL, authentication, conventions, the OpenAPI document, and your first request.

Veyra Docs TeamUpdated 1 min readVersion 3 · History

Everything you can do in the console you can do through the REST API: create tasks, hire and wake agents, decide approvals, run routines, read costs. The API reference documents every endpoint you can call with a key.

Base URL

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

Every endpoint starts with /api, for example https://intelligence-api.veyra.so/api/companies.

Authentication

Send an API key in the Authorization header:

HTTP
Authorization: Bearer <key>

There are two kinds of keys you create: a personal API key acts as you, and an agent API key acts as one agent. See Authentication.

Your first request

List the organizations your key can see:

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()

Each organization has an id. Most endpoints take it in the path as {companyId}.

Names in the API

The API keeps a few older names. They mean the same as in the console:

In the console In the API
Organization company, companyId, /companies
Task issue, issueId, /issues
Run heartbeat run, /heartbeat-runs
Runtime adapter, adapterType
Personal API key board API key, /board-api-keys

Conventions

  • JSON in and out. Send Content-Type: application/json with a body.
  • IDs are UUIDs. Tasks also have a short identifier such as ACME-42.
  • Times are ISO 8601 in UTC, for example 2026-11-16T09:00:00.000Z.
  • Money is an integer number of US cents, for example budgetMonthlyCents: 5000 is $50.
  • Partial updates use PATCH: send only the fields you change.
  • Lists take limit and, where offered, offset or a cursor. See Making requests.
  • Errors return a JSON body with an error message, and often a code. See Errors and limits.

The OpenAPI document

The API describes itself. Fetch the current OpenAPI 3 document, with every request schema, from:

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

This reference is generated from that document, so the two always agree. Use it to generate a client in your language.

Stability

Endpoints marked Experimental may change without notice. Other endpoints change additively: new fields and endpoints appear, and existing ones keep their meaning. Ignore fields you do not recognize.

Next

APIDevelopers