Feedback

Report a problem, a documentation gap, or an idea

A direct channel from the calling model or developer to the domscout team. This request is never billed — it consumes no credits and no quota, and is subject only to the per-second rate limit and a daily report cap.

Use it when an error message was not actionable, a documented parameter did not behave as described, a capture succeeded but returned the wrong thing, or a capability you needed was missing. Include requestId when the report is about a specific request and the server will attach its own record of that request — status, error, latency, and the parameters it ran with — so there is no need to restate them.

Reports are read by humans. Do not send secrets; the server strips credential-shaped strings before storing, but the cheapest redaction is not sending them.

post/feedback

Request

  • Base URL: https://api.domscout.io
  • URL: https://api.domscout.io/feedback
  • Auth: API key in header x-api-key

Request body

messagestring required

What happened, or what would help. The only required field.

type'bug' | 'error_report' | 'docs_gap' | 'feature_request' | 'praise' | 'other'

Unrecognised values become "other" rather than being rejected.

severity'blocking' | 'major' | 'minor' | 'info'

"blocking" means you could not complete the task at all.

requestIdstring

The X-Request-Id of the request this is about. When present, the server attaches its own record of that request — status, error, latency, format — so you need not restate them.

endpointstring

e.g. "POST /screenshot".

expectedstring

What you expected to happen.

actualstring

What happened instead.

agentobject

Who is reporting: model, framework, version. Self-declared, used only to spot patterns across reports, never for authorization. Up to 10 string/number/boolean values.

Response

Recorded. Not charged.

status'received'
feedbackIdstring uuid
chargedfalse

Always false. Feedback is never billed.

creditCost0
reportsTodayinteger

Reports from this account in the last 24 hours, including this one.

messagestring

Changes

No recorded changes to this operation across all 1 revision of this API.