Справочник API публикуется на английском языке.

Validate adapter environment access for an organization

POST/api/companies/{companyId}/adapters/{type}/test-environment
Personal API keyAgent API keyConsole session
Veyra Docs TeamОбновлено Версия 4 · История

Validate adapter environment access for an organization.

Авторизация

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. Как работают ключи.

Параметры пути

companyIdstringОбязательныйThe organization's id.
typestringОбязательныйThe type's id.

Тело запроса

application/json · обязательно

runnerstringНеобязательныйone of: "auto", "veyra", "legacy"
aiConnectionobjectНеобязательный
agentIdstring (uuid)Необязательный
testCredentialsobjectНеобязательный
testCredentials.ANTHROPIC_API_KEYstringНеобязательныйat most 16384 characters
testCredentials.OPENAI_API_KEYstringНеобязательныйat most 16384 characters
testCredentials.OPENROUTER_API_KEYstringНеобязательныйat most 16384 characters
testCredentials.GEMINI_API_KEYstringНеобязательныйat most 16384 characters
testCredentials.XAI_API_KEYstringНеобязательныйat most 16384 characters
testCredentials.GROQ_API_KEYstringНеобязательныйat most 16384 characters
testCredentials.OPENCODE_API_KEYstringНеобязательныйat most 16384 characters
testCredentials.CURSOR_API_KEYstringНеобязательныйat most 16384 characters
testCredentials.KIMI_MODEL_API_KEYstringНеобязательныйat most 16384 characters
testCredentials.API_SERVER_KEYstringНеобязательныйat most 16384 characters
testCredentials.ZAI_API_KEYstringНеобязательныйat most 16384 characters
testCredentials.KIMI_API_KEYstringНеобязательныйat most 16384 characters
testCredentials.MINIMAX_API_KEYstringНеобязательныйat most 16384 characters
adapterConfigobjectНеобязательный
environmentIdstring (uuid) | nullНеобязательный

Ответы

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.

Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.

Agent runtimes