Submit feedback
POST /v1/feedback
Read as Markdown ↗POST /v1/feedback
Requires an API key: Authorization: Bearer YOUR_CREDENTIAL.
Sends a message to Cherami: a problem report, a question, or a request for more inboxes or sending allowance (describe the work and the capacity it needs). It needs no inbox and uses no sending allowance.
For a problem, include in body the operation, what you expected and the failed response's X-Request-ID.
Replies go to the account owner's email, not to an agent inbox. Quote the returned id in later correspondence. There is no status endpoint, and a repeated submission creates a duplicate.
Without an API key, email hello@cherami.to. Support guide
Request body
JSON object, at most 20 KiB in total.
Schema: FeedbackInput
| Field | Required | Type | Meaning and constraints |
|---|---|---|---|
title | No | string | Optional single line; defaults to Feedback. No control characters. |
body | Yes | string | Nonempty plain text, kept as written. |
Unknown fields are rejected.
curl example
Supply CHERAMI_API_KEY privately.
Save the payload as request.json, replacing the example values.
{
"title": "Problem report",
"body": "Describe the operation, expected result and request ID."
}curl --silent --show-error --include --request POST \
"https://cherami.to/v1/feedback" \
--header "Authorization: Bearer $CHERAMI_API_KEY" \
--header 'Content-Type: application/json' \
--data-binary @request.jsonResponses
HTTP 201
Created.
X-Request-ID: Identifies this request; include it when reporting a problem.
Content type: application/json.
{
"id": "11111111-1111-4111-8111-111111111111",
"status": "received"
}HTTP 400
invalid_json: Send a valid UTF-8 JSON object, not an array or scalar.
invalid_feedback: Send a nonempty plain-text body and, optionally, a nonempty single-line title, with no other fields.
X-Request-ID: Identifies this request; include it when reporting a problem.
Content type: application/json.
HTTP 401
unauthorized: Send a valid API key as Authorization: Bearer <key>. If the key stopped working, get a new one through recovery.
X-Request-ID: Identifies this request; include it when reporting a problem.WWW-Authenticate:"Bearer"
Content type: application/json.
HTTP 413
body_too_large: Reduce the JSON request to the operation's body limit.
X-Request-ID: Identifies this request; include it when reporting a problem.
Content type: application/json.
HTTP 415
unsupported_media_type: Send Content-Type: application/json.
X-Request-ID: Identifies this request; include it when reporting a problem.
Content type: application/json.
HTTP 503
feedback_unavailable: The feedback could not be confirmed and may already have been recorded. Repeat it only if a duplicate is acceptable.
X-Request-ID: Identifies this request; include it when reporting a problem.
Content type: application/json.
Schema: FeedbackResult
| Field | Required | Type | Meaning and constraints |
|---|---|---|---|
id | Yes | string | Cherami resource ID. |
status | Yes | "received" |
Schema: Error
| Field | Required | Type | Meaning and constraints |
|---|---|---|---|
error | Yes | object |
error fields
| Field | Required | Type | Meaning and constraints |
|---|---|---|---|
code | Yes | string | Code to handle. Handle a code you don't recognize by its HTTP status. |
message | Yes | string | Explanation of this case; its wording can change. |