API referansı İngilizce yayımlanır.

Create a short-lived single-use personal Muse pairing ticket

POST/api/companies/{companyId}/agents/{agentId}/muse-binding
Personal API keyConsole session
Veyra Docs TeamGüncellendi Sürüm 3 · Geçmiş

Create a short-lived single-use personal Muse pairing ticket.

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.
agentIdstringZorunluThe agent's id.

İstek gövdesi

application/json · zorunlu

replaceBindingIdstringİsteğe bağlı
expectedRevisionintegerİsteğe bağlı> 0

Yanıtlar

201SuccessCreated; the body holds the new resource.
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).
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.

Agents