Check an owned local subscription sign-in without saving a connection

POST/api/companies/{companyId}/ai-connections/local/check
Personal API keyAgent API keyConsole session
Veyra Docs TeamUpdated Version 3 · History

Check an owned local subscription sign-in without saving a connection.

Authorization

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. How keys work.

Path parameters

companyIdstringRequiredThe organization's id.

Request body

application/json · required

providerstringRequiredone of: "anthropic", "openai", "xai", "google"
methodstringRequiredone of: "subscription"
namestringRequired1–160 characters
ownershipstringRequiredone of: "personal", "shared"
connectionIdstring (uuid)Optional
agentIdsarray<string (uuid)>Optional
allAgentsbooleanOptional
localSessionIdstring (uuid)Optional

Responses

200SuccessThe request worked; the body holds the result.
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).

Errors return {"error": "..."}, often with a code and details. See errors and limits.

AI connections