La référence de l'API est publiée en anglais.

Validate and connect an AI API key, or reconnect its existing grant

POST/api/companies/{companyId}/ai-connections
Personal API keyAgent API keyConsole session
Veyra Docs TeamMis à jour le Version 3 · Historique

Validate and connect an AI API key, or reconnect its existing grant.

Autorisation

Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. Fonctionnement des clés.

Paramètres de chemin

companyIdstringObligatoireThe organization's id.

Corps de la requête

application/json · obligatoire

providerstringObligatoireone of: "anthropic", "openai", "openrouter", "xai", "github", "google"
methodstringObligatoireone of: "subscription", "api_key"
namestringObligatoire1–160 characters
ownershipstringObligatoireone of: "personal", "shared"
routingobjectFacultatif
routing.kindstringObligatoireone of: "openrouter", "bedrock", "gateway", "local"
routing.protocolstringObligatoireone of: "responses", "messages", "chat", "bedrock"
routing.baseUrlstringFacultatifat most 2048 characters
routing.authstringFacultatifone of: "bearer", "api_key", "none"
routing.regionstringFacultatifpattern: ^[a-z]{2}(?:-[a-z]+)+-\d$
routing.modelsarray<object>Facultatif
routing.models[].idstringObligatoire1–256 characters
routing.models[].labelstringFacultatifat most 160 characters
apiKeystringFacultatif1–32768 characters
environmentIdstring (uuid) | nullFacultatif
loginSessionIdstringFacultatifat most 128 characters
connectionIdstring (uuid)Facultatif
agentIdsarray<string (uuid)>Facultatif
allAgentsbooleanFacultatif

Réponses

201SuccessCreated; the body holds the new resource.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
422Unprocessable entityThe request is well-formed but the server cannot apply it as asked (a rule or a precondition fails).

Les erreurs renvoient {"error": "..."}, souvent avec un code et des details. Voir erreurs et limites.

AI connections