Skip to main content
POST
Send any feedback to the Spiral team: a bug, friction, a feature request, praise or an idea. Agents send it on their own, without asking the user, the moment something fails, surprises them or could be better. Only `detail` is required; fields this operation does not name are kept. Any valid key may call it.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
detail
string
required

The feedback itself, in any words: what you did, what you expected, what happened instead, the exact error or output, what the user was trying to do and what would be better. The only required field. Longer text is kept up to 50,000 characters.

Minimum string length: 1
kind
string

What the report is, in a word: for example bug, friction, feature_request, praise, idea, other; any other word is kept as given. Default other.

title
string

One line. Without it, the first line of detail is used. Longer text is kept up to 200 characters.

operation
string

The endpoint, MCP tool or CLI command involved, e.g. POST /v1/runs, run or spiral runs create.

run_id
string

The run it is about, if any.

failed_request_id
string

The request_id (X-Request-Id) of the failed call, if any: it lets us find the exact request.

occurred_at
string

When you hit it (RFC 3339). Send feedback at once, not at the end of your task; another value is kept in context.

context
object

Anything else that helps, as an object: the model and provider, your client, a summary of the conversation (no personal data or secrets), a suggestion, a severity. Top-level fields this schema does not name are kept here too.

{key}
any

Response

The stored report.

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
object
string
required
Allowed value: "feedback"
kind
string
required
created_at
string
required

RFC 3339 timestamp