Обзор API

REST API Veyra Intelligence коротко: базовый URL, аутентификация, соглашения, документ OpenAPI и первый запрос.

Veyra Docs TeamОбновлено 1 мин чтенияВерсия 2 · История

Всё, что можно сделать в консоли, можно сделать через REST API: создавать задачи, нанимать и будить агентов, принимать решения по согласованиям, запускать рутины, получать данные о расходах. В справочнике API описан каждый метод, который можно вызвать с ключом.

Базовый URL

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

Каждый метод начинается с /api, например https://intelligence-api.veyra.so/api/companies.

Аутентификация

Передайте API-ключ в заголовке Authorization:

HTTP
Authorization: Bearer <key>

Вы создаёте ключи двух видов: личный API-ключ действует от вашего имени, API-ключ агента — от имени одного агента. См. Аутентификация.

Первый запрос

Получите список организаций, которые видит ваш ключ:

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

У каждой организации есть id. Большинство методов принимают его в пути как {companyId}.

Названия в API

В API сохранились некоторые старые названия. Они означают то же, что и в консоли:

В консоли В API
Организация company, companyId, /companies
Задача issue, issueId, /issues
Запуск heartbeat run, /heartbeat-runs
Среда выполнения adapter, adapterType
Личный API-ключ board API key, /board-api-keys

Соглашения

  • На входе и выходе — JSON. Если есть тело, передавайте Content-Type: application/json.
  • Идентификаторы — UUID. У задач есть ещё короткий идентификатор, например ACME-42.
  • Время указывается в ISO 8601 и UTC, например 2026-11-16T09:00:00.000Z.
  • Деньги — целое число центов США: budgetMonthlyCents: 5000 — это 50 $.
  • Частичные обновления выполняются через PATCH: отправляйте только изменённые поля.
  • Списки принимают limit и, где это предусмотрено, offset или курсор. См. Выполнение запросов.
  • Ошибки возвращают JSON с сообщением error и часто с code. См. Ошибки и ограничения.

Документ OpenAPI

API описывает сам себя. Актуальный документ OpenAPI 3 со всеми схемами запросов доступен по адресу:

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

Этот справочник создаётся из того же документа, поэтому они всегда совпадают. По нему можно сгенерировать клиент на вашем языке.

Стабильность

Методы с пометкой Experimental могут измениться без предупреждения. Остальные меняются только за счёт добавлений: появляются новые поля и методы, а существующие сохраняют смысл. Игнорируйте поля, которые вам незнакомы.

Что дальше

APIРазработчикам