Create a status card

POST/api/companies/{companyId}/status-cards
Personal API keyAgent API keyConsole session
Veyra Docs TeamUpdated Version 3 · History

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

Authorization

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. How keys work.

Path parameters

companyIdstringRequiredThe organization's id.

Request body

application/json · required

interestPromptstringRequired1–20000 characters
titlestringOptional1–300 characters
titlePinnedbooleanOptional
agentIdstring (uuid) | nullOptional
refreshPolicyobjectOptional
refreshPolicy.modestringOptionalone of: "manual", "interval", "reactive"
refreshPolicy.intervalMinutesintegerOptional> 0
refreshPolicy.debounceSecondsintegerOptional> 0
refreshPolicy.maxUpdatesPerHourintegerOptional> 0
refreshPolicy.triggersanyRequired
refreshPolicy.activeHoursobjectOptional
refreshPolicy.activeHours.startstringRequiredpattern: ^([01]\d|2[0-3]):[0-5]\d$
refreshPolicy.activeHours.endstringRequiredpattern: ^([01]\d|2[0-3]):[0-5]\d$
refreshPolicy.activeHours.timezonestringRequiredat least 1 character
refreshPolicy.dailyTokenCapintegerOptional> 0

Responses

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.

Errors return {"error": "..."}, often with a code and details. See errors and limits.

Status cards