API referansı İngilizce yayımlanır.
Provision a built-in agent
POST
/api/companies/{companyId}/built-in-agents/{key}/provisionPersonal API keyAgent API keyConsole session
Provision a built-in agent.
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.
keystringZorunluThe built in agent's key.
İstek gövdesi
application/json · zorunlu
adapterTypestringİsteğe bağlı
at least 1 characterrunnerstringİsteğe bağlı
one of: "auto", "veyra", "legacy"adapterConfigobjectİsteğe bağlı
budgetMonthlyCentsintegerİsteğe bağlı
≥ 0Yanıtlar
200SuccessThe request worked; the body holds the result.
202SuccessAccepted; the work continues in the background.
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.
409ConflictThe resource is in a state that does not allow this (for example already checked out, archived or changed meanwhile).
Hatalar {"error": "..."} döndürür, çoğu zaman bir code ve details ile birlikte. Ayrıntılar için: hatalar ve limitler.