API referansı İngilizce yayımlanır.

Configure the organization fast response model

PUT/api/companies/{companyId}/fast-response
Personal API keyConsole session
Veyra Docs TeamGüncellendi Sürüm 3 · Geçmiş

Configure the organization fast response model.

People who manage connections configure, enable and test this in the Fast response section of the organization-prefixed /company/settings/connections page; link it as a Markdown link to //company/settings/connections, not the general /company/settings page. The section is shown only while an instance admin has fast responses turned on in //company/settings/instance/experimental. Agent credentials cannot change or test it.

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.

Yol parametreleri

companyIdstringZorunluThe organization's id.

İstek gövdesi

application/json · zorunlu

enabledbooleanZorunlu
connectionIdstring (uuid) | nullZorunlu
grantIdstring (uuid) | nullZorunlu
modelstring | nullZorunlu1–256 characters
allowSponsoredbooleanİ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.
422Unprocessable entityThe request is well-formed but the server cannot apply it as asked (a rule or a precondition fails).

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

Fast responses