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

Prepare an isolated local subscription sign-in

POST/api/companies/{companyId}/ai-connections/local/attempts
Personal API keyAgent API keyConsole session
Veyra Docs TeamActualizado el Versión 3 · Historial

Prepare an isolated local subscription sign-in.

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", "xai", "google"
methodstringObligatorioone of: "subscription"
namestringObligatorio1–160 characters
ownershipstringObligatorioone of: "personal", "shared"
connectionIdstring (uuid)Opcional
agentIdsarray<string (uuid)>Opcional
allAgentsbooleanOpcional
restartbooleanOpcional

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