La référence de l'API est publiée en anglais.

Validate adapter environment access for an organization

POST/api/companies/{companyId}/adapters/{type}/test-environment
Personal API keyAgent API keyConsole session
Veyra Docs TeamMis à jour le Version 4 · Historique

Validate adapter environment access for an organization.

Autorisation

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. Fonctionnement des clés.

Paramètres de chemin

companyIdstringObligatoireThe organization's id.
typestringObligatoireThe type's id.

Corps de la requête

application/json · obligatoire

runnerstringFacultatifone of: "auto", "veyra", "legacy"
aiConnectionobjectFacultatif
agentIdstring (uuid)Facultatif
testCredentialsobjectFacultatif
testCredentials.ANTHROPIC_API_KEYstringFacultatifat most 16384 characters
testCredentials.OPENAI_API_KEYstringFacultatifat most 16384 characters
testCredentials.OPENROUTER_API_KEYstringFacultatifat most 16384 characters
testCredentials.GEMINI_API_KEYstringFacultatifat most 16384 characters
testCredentials.XAI_API_KEYstringFacultatifat most 16384 characters
testCredentials.GROQ_API_KEYstringFacultatifat most 16384 characters
testCredentials.OPENCODE_API_KEYstringFacultatifat most 16384 characters
testCredentials.CURSOR_API_KEYstringFacultatifat most 16384 characters
testCredentials.KIMI_MODEL_API_KEYstringFacultatifat most 16384 characters
testCredentials.API_SERVER_KEYstringFacultatifat most 16384 characters
testCredentials.ZAI_API_KEYstringFacultatifat most 16384 characters
testCredentials.KIMI_API_KEYstringFacultatifat most 16384 characters
testCredentials.MINIMAX_API_KEYstringFacultatifat most 16384 characters
adapterConfigobjectFacultatif
environmentIdstring (uuid) | nullFacultatif

Réponses

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.

Les erreurs renvoient {"error": "..."}, souvent avec un code et des details. Voir erreurs et limites.

Agent runtimes