Skip to main content
POST
Submit agent feedback
0 Credits See Agent Feedback for when to report and what to include.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <API_KEY>. Keys have full access by default.

Body

application/json
category
enum<string>
required

Kind of issue.

Available options:
bug,
docs_mismatch,
friction,
feature_gap,
quality_degradation,
other
note
string
required

What went wrong and what you expected instead.

Required string length: 1 - 4000
Example:

"Markdown drops the plan comparison table; expected all 4 rows."

request_id
string<uuid>

The request_id of the API call the feedback is about, from its response body or X-Request-Id header.

Example:

"3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91"

url
string<uri>

The page the feedback is about, such as one page of a crawl or a docs page.

Maximum string length: 2048
Example:

"https://stripe.com/pricing"

tags
string[]

Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.

Maximum array length: 20
Required string length: 1 - 50
Example:

Response

Feedback for this request_id was already recorded

feedback_id
string
required

ID of the stored feedback.

Example:

"fb_8f14e45fceea167a5a36dedd4bea2543"

already_submitted
boolean
required

True when feedback for this request_id was already recorded; the original feedback_id is returned.

request_id
string<uuid>
required

Unique id of this API call, also sent in the X-Request-Id response header. Quote it when contacting support about a failed request.

Example:

"3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91"

key_metadata
object

Credit usage, included whenever a valid API key is provided.