La referencia de la API se publica en inglés.

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 TeamActualizado el Versión 3 · Historial

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

Autorización

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. Cómo funcionan las claves.

Parámetros de ruta

companyIdstringObligatorioThe organization's id.

Cuerpo de la solicitud

application/json · obligatorio

providerstringObligatorioone of: "anthropic", "openai", "openrouter", "xai", "github", "google"
methodstringObligatorioone of: "subscription", "api_key"
namestringObligatorio1–160 characters
ownershipstringObligatorioone of: "personal", "shared"
routingobjectOpcional
routing.kindstringObligatorioone of: "openrouter", "bedrock", "gateway", "local"
routing.protocolstringObligatorioone of: "responses", "messages", "chat", "bedrock"
routing.baseUrlstringOpcionalat most 2048 characters
routing.authstringOpcionalone of: "bearer", "api_key", "none"
routing.regionstringOpcionalpattern: ^[a-z]{2}(?:-[a-z]+)+-\d$
routing.modelsarray<object>Opcional
routing.models[].idstringObligatorio1–256 characters
routing.models[].labelstringOpcionalat most 160 characters
apiKeystringOpcional1–32768 characters
environmentIdstring (uuid) | nullOpcional
loginSessionIdstringOpcionalat most 128 characters
connectionIdstring (uuid)Opcional
agentIdsarray<string (uuid)>Opcional
allAgentsbooleanOpcional

Respuestas

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

Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.

AI connections