API referansı İngilizce yayımlanır.

Validate adapter environment access for an organization

POST/api/companies/{companyId}/adapters/{type}/test-environment
Personal API keyAgent API keyConsole session
Veyra Docs TeamGüncellendi Sürüm 4 · Geçmiş

Validate adapter environment access for an organization.

Yetkilendirme

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. Anahtarlar nasıl çalışır.

Yol parametreleri

companyIdstringZorunluThe organization's id.
typestringZorunluThe type's id.

İstek gövdesi

application/json · zorunlu

runnerstringİsteğe bağlıone of: "auto", "veyra", "legacy"
aiConnectionobjectİsteğe bağlı
agentIdstring (uuid)İsteğe bağlı
testCredentialsobjectİsteğe bağlı
testCredentials.ANTHROPIC_API_KEYstringİsteğe bağlıat most 16384 characters
testCredentials.OPENAI_API_KEYstringİsteğe bağlıat most 16384 characters
testCredentials.OPENROUTER_API_KEYstringİsteğe bağlıat most 16384 characters
testCredentials.GEMINI_API_KEYstringİsteğe bağlıat most 16384 characters
testCredentials.XAI_API_KEYstringİsteğe bağlıat most 16384 characters
testCredentials.GROQ_API_KEYstringİsteğe bağlıat most 16384 characters
testCredentials.OPENCODE_API_KEYstringİsteğe bağlıat most 16384 characters
testCredentials.CURSOR_API_KEYstringİsteğe bağlıat most 16384 characters
testCredentials.KIMI_MODEL_API_KEYstringİsteğe bağlıat most 16384 characters
testCredentials.API_SERVER_KEYstringİsteğe bağlıat most 16384 characters
testCredentials.ZAI_API_KEYstringİsteğe bağlıat most 16384 characters
testCredentials.KIMI_API_KEYstringİsteğe bağlıat most 16384 characters
testCredentials.MINIMAX_API_KEYstringİsteğe bağlıat most 16384 characters
adapterConfigobjectİsteğe bağlı
environmentIdstring (uuid) | nullİsteğe bağlı

Yanıtlar

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.

Hatalar {"error": "..."} döndürür, çoğu zaman bir code ve details ile birlikte. Ayrıntılar için: hatalar ve limitler.

Agent runtimes