Vue d'ensemble de l'API

L'API REST de Veyra Intelligence en un coup d'œil : URL de base, authentification, conventions, document OpenAPI et première requête.

Veyra Docs TeamMis à jour le 2 min de lectureVersion 2 · Historique

Tout ce que vous faites dans la console, vous pouvez le faire avec l'API REST : créer des tâches, recruter et réveiller des agents, décider des approbations, lancer des routines, consulter les coûts. La référence de l'API documente chaque endpoint que vous pouvez appeler avec une clé.

URL de base

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

Chaque endpoint commence par /api, par exemple https://intelligence-api.veyra.so/api/companies.

Authentification

Envoyez une clé d'API dans l'en-tête Authorization :

HTTP
Authorization: Bearer <key>

Vous créez deux sortes de clés : une clé d'API personnelle agit en votre nom, une clé d'API d'agent agit au nom d'un agent. Voir Authentification.

Votre première requête

Listez les organisations que votre clé peut voir :

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

Chaque organisation a un id. La plupart des endpoints le prennent dans le chemin sous la forme {companyId}.

Les noms dans l'API

L'API conserve quelques anciens noms. Ils ont le même sens que dans la console :

Dans la console Dans l'API
Organisation company, companyId, /companies
Tâche issue, issueId, /issues
Exécution heartbeat run, /heartbeat-runs
Environnement d'exécution adapter, adapterType
Clé d'API personnelle board API key, /board-api-keys

Conventions

  • JSON en entrée comme en sortie. Envoyez Content-Type: application/json avec un corps.
  • Les identifiants sont des UUID. Les tâches ont aussi un identifiant court comme ACME-42.
  • Les dates sont en ISO 8601 et en UTC, par exemple 2026-11-16T09:00:00.000Z.
  • Les montants sont un nombre entier de cents américains : budgetMonthlyCents: 5000 vaut 50 $.
  • Les mises à jour partielles utilisent PATCH : n'envoyez que les champs modifiés.
  • Les listes acceptent limit et, quand c'est proposé, offset ou un curseur. Voir Envoyer des requêtes.
  • Les erreurs renvoient un corps JSON avec un message error, et souvent un code. Voir Erreurs et limites.

Le document OpenAPI

L'API se décrit elle-même. Récupérez le document OpenAPI 3 à jour, avec chaque schéma de requête, à l'adresse :

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

Cette référence est générée à partir de ce document : les deux concordent toujours. Servez-vous-en pour générer un client dans votre langage.

Stabilité

Les endpoints marqués Experimental peuvent changer sans préavis. Les autres évoluent uniquement par ajout : de nouveaux champs et endpoints apparaissent, les existants gardent leur sens. Ignorez les champs que vous ne connaissez pas.

Pour continuer

APIDéveloppeurs