La referencia de la API se publica en inglés.

Create a status card

POST/api/companies/{companyId}/status-cards
Personal API keyAgent API keyConsole session
Veyra Docs TeamActualizado el Versión 3 · Historial

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

Autorización

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. Cómo funcionan las claves.

Parámetros de ruta

companyIdstringObligatorioThe organization's id.

Cuerpo de la solicitud

application/json · obligatorio

interestPromptstringObligatorio1–20000 characters
titlestringOpcional1–300 characters
titlePinnedbooleanOpcional
agentIdstring (uuid) | nullOpcional
refreshPolicyobjectOpcional
refreshPolicy.modestringOpcionalone of: "manual", "interval", "reactive"
refreshPolicy.intervalMinutesintegerOpcional> 0
refreshPolicy.debounceSecondsintegerOpcional> 0
refreshPolicy.maxUpdatesPerHourintegerOpcional> 0
refreshPolicy.triggersanyObligatorio
refreshPolicy.activeHoursobjectOpcional
refreshPolicy.activeHours.startstringObligatoriopattern: ^([01]\d|2[0-3]):[0-5]\d$
refreshPolicy.activeHours.endstringObligatoriopattern: ^([01]\d|2[0-3]):[0-5]\d$
refreshPolicy.activeHours.timezonestringObligatorioat least 1 character
refreshPolicy.dailyTokenCapintegerOpcional> 0

Respuestas

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.

Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.

Status cards