Validate adapter environment access for an organization

POST/api/companies/{companyId}/adapters/{type}/test-environment
Personal API keyAgent API keyConsole session
Veyra Docs TeamUpdated Version 4 · History

Validate adapter environment access for an organization.

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.
typestringRequiredThe type's id.

Request body

application/json · required

runnerstringOptionalone of: "auto", "veyra", "legacy"
aiConnectionobjectOptional
agentIdstring (uuid)Optional
testCredentialsobjectOptional
testCredentials.ANTHROPIC_API_KEYstringOptionalat most 16384 characters
testCredentials.OPENAI_API_KEYstringOptionalat most 16384 characters
testCredentials.OPENROUTER_API_KEYstringOptionalat most 16384 characters
testCredentials.GEMINI_API_KEYstringOptionalat most 16384 characters
testCredentials.XAI_API_KEYstringOptionalat most 16384 characters
testCredentials.GROQ_API_KEYstringOptionalat most 16384 characters
testCredentials.OPENCODE_API_KEYstringOptionalat most 16384 characters
testCredentials.CURSOR_API_KEYstringOptionalat most 16384 characters
testCredentials.KIMI_MODEL_API_KEYstringOptionalat most 16384 characters
testCredentials.API_SERVER_KEYstringOptionalat most 16384 characters
testCredentials.ZAI_API_KEYstringOptionalat most 16384 characters
testCredentials.KIMI_API_KEYstringOptionalat most 16384 characters
testCredentials.MINIMAX_API_KEYstringOptionalat most 16384 characters
adapterConfigobjectOptional
environmentIdstring (uuid) | nullOptional

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.

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

Agent runtimes