API referansı İngilizce yayımlanır.

Create a status card

POST/api/companies/{companyId}/status-cards
Personal API keyAgent API keyConsole session
Veyra Docs TeamGüncellendi Sürüm 3 · Geçmiş

Create a status card.

Creates a saved status card on the organization's Status page: a live summary of the tasks the interestPrompt describes. agentId names the agent that writes its summary; without it the built-in Summarizer is used when configured. The response is returned before any summary exists: the card's summarizer compiles its query and writes the first summary in its own run. Do not wait or poll for it; reply now with the returned href as a Markdown link, which opens the card at //status/.

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.

İstek gövdesi

application/json · zorunlu

interestPromptstringZorunlu1–20000 characters
titlestringİsteğe bağlı1–300 characters
titlePinnedbooleanİsteğe bağlı
agentIdstring (uuid) | nullİsteğe bağlı
refreshPolicyobjectİsteğe bağlı
refreshPolicy.modestringİsteğe bağlıone of: "manual", "interval", "reactive"
refreshPolicy.intervalMinutesintegerİsteğe bağlı> 0
refreshPolicy.debounceSecondsintegerİsteğe bağlı> 0
refreshPolicy.maxUpdatesPerHourintegerİsteğe bağlı> 0
refreshPolicy.triggersanyZorunlu
refreshPolicy.activeHoursobjectİsteğe bağlı
refreshPolicy.activeHours.startstringZorunlupattern: ^([01]\d|2[0-3]):[0-5]\d$
refreshPolicy.activeHours.endstringZorunlupattern: ^([01]\d|2[0-3]):[0-5]\d$
refreshPolicy.activeHours.timezonestringZorunluat least 1 character
refreshPolicy.dailyTokenCapintegerİ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.

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

Status cards