Feedback

Send feedback to Zindex staff

Tell Zindex staff about a bug, a place where the docs and the engine disagree, or something you needed that is missing, with or without a diagram. The person confirms each item: without confirm, nothing is stored and the answer is 400 CONFIRMATION_REQUIRED with preview (the item exactly as staff will see it, with the engine version and client Zindex adds) and a confirm token. Show the person the preview, and only if they agree, send the same body again with confirm; the token is valid for 10 minutes, for this account and this item only. An attached diagram version (id, revision) or snippet is anonymized unless anonymize is false. An account can send 20 items in any 24 hours. Staff read every item; no model does. GET /v1/feedback shows each item's status. Over MCP: diagram_share with action feedback.

post/v1/feedback

Request

  • Base URL: https://api.zindex.ai
  • URL: https://api.zindex.ai/v1/feedback
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Headers

X-Zindex-Clientstring

Your client's name and version, such as my-agent/1.2, kept as the client that made the revision, report or feedback item, as history and outlines show it. The first 100 characters are kept. Without it, the User-Agent's first product token is used.

Request body

kind'bug' | 'docs' | 'request' | 'other' required

docs: the docs and the engine disagree

summarystring required

One line

expectedstring
observedstring
confidence'seen' | 'likely' | 'unsure'
idstring

A diagram to attach, by ID or key; not with snippet

revisioninteger

With id: the version; default the latest

anonymizeboolean

Anonymize the attached diagram or snippet

confirmstring

The token from CONFIRMATION_REQUIRED, once the person agreed

Response

Sent: { feedbackId, sent: true, status: "new" }

feedbackIdstring required

fb_ plus 12 characters

senttrue required
status'new' required

Changes

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