Справочник API публикуется на английском языке.

Create a status card

POST/api/companies/{companyId}/status-cards
Personal API keyAgent API keyConsole session
Veyra Docs TeamОбновлено Версия 3 · История

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/.

Авторизация

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. Как работают ключи.

Параметры пути

companyIdstringОбязательныйThe organization's id.

Тело запроса

application/json · обязательно

interestPromptstringОбязательный1–20000 characters
titlestringНеобязательный1–300 characters
titlePinnedbooleanНеобязательный
agentIdstring (uuid) | nullНеобязательный
refreshPolicyobjectНеобязательный
refreshPolicy.modestringНеобязательныйone of: "manual", "interval", "reactive"
refreshPolicy.intervalMinutesintegerНеобязательный> 0
refreshPolicy.debounceSecondsintegerНеобязательный> 0
refreshPolicy.maxUpdatesPerHourintegerНеобязательный> 0
refreshPolicy.triggersanyОбязательный
refreshPolicy.activeHoursobjectНеобязательный
refreshPolicy.activeHours.startstringОбязательныйpattern: ^([01]\d|2[0-3]):[0-5]\d$
refreshPolicy.activeHours.endstringОбязательныйpattern: ^([01]\d|2[0-3]):[0-5]\d$
refreshPolicy.activeHours.timezonestringОбязательныйat least 1 character
refreshPolicy.dailyTokenCapintegerНеобязательный> 0

Ответы

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.

Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.

Status cards