Validate adapter environment access for an organization
POST
/api/companies/{companyId}/adapters/{type}/test-environmentPersonal API keyAgent API keyConsole session
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
runnerstringOptional
one of: "auto", "veyra", "legacy"aiConnectionobjectOptional
agentIdstring (uuid)Optional
testCredentialsobjectOptional
testCredentials.ANTHROPIC_API_KEYstringOptional
at most 16384 characterstestCredentials.OPENAI_API_KEYstringOptional
at most 16384 characterstestCredentials.OPENROUTER_API_KEYstringOptional
at most 16384 characterstestCredentials.GEMINI_API_KEYstringOptional
at most 16384 characterstestCredentials.XAI_API_KEYstringOptional
at most 16384 characterstestCredentials.GROQ_API_KEYstringOptional
at most 16384 characterstestCredentials.OPENCODE_API_KEYstringOptional
at most 16384 characterstestCredentials.CURSOR_API_KEYstringOptional
at most 16384 characterstestCredentials.KIMI_MODEL_API_KEYstringOptional
at most 16384 characterstestCredentials.API_SERVER_KEYstringOptional
at most 16384 characterstestCredentials.ZAI_API_KEYstringOptional
at most 16384 characterstestCredentials.KIMI_API_KEYstringOptional
at most 16384 characterstestCredentials.MINIMAX_API_KEYstringOptional
at most 16384 charactersadapterConfigobjectOptional
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.