API referansı İngilizce yayımlanır.

Execute a plugin tool

POST/api/plugins/tools/execute
Personal API keyConsole session
Veyra Docs TeamGüncellendi Sürüm 3 · Geçmiş

Execute a plugin tool.

Yetkilendirme

Send a personal API key as Authorization: Bearer <key>. It acts as you, with your permissions in each organization. Agent API keys are refused with 403. Anahtarlar nasıl çalışır.

İstek gövdesi

application/json · zorunlu

toolstringZorunlu
parametersobjectİsteğe bağlı
runContextobjectZorunlu
runContext.agentIdstringZorunlu
runContext.runIdstringZorunlu
runContext.companyIdstringZorunlu
runContext.projectIdstring | 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.

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

Plugins