feedback

Submit agent feedback

Report an API issue or documentation mismatch, including the request id of the call it is about when you have one.

Returns 201 when the feedback is stored, or 200 with already_submitted: true when feedback for the same request_id was already recorded on this account.

post/v1/feedback

Request body

category'bug' | 'docs_mismatch' | 'friction' | 'feature_gap' | 'quality_degradation' | 'other' required

Kind of issue: bug, docs_mismatch, friction, feature_gap, quality_degradation or other.

notestring required

What went wrong and what you expected instead. 1 to 4000 characters.

request_idstring uuid nullable

The request_id of the API call the feedback is about, from the X-Request-Id response header or the error body. Feedback is stored once per request id.

urlstring nullable

The page the feedback is about, such as a docs page. http(s) only, up to 2048 characters.

tagsstring[] nullable

Labels for filtering, up to 20, each 1 to 50 characters.

Example request

{
  "note": "GET /v1/numbers?externalId= returns 200 with an empty list; expected 404 or 422.",
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91",
  "url": "https://docs.agentphone.ai/messages",
  "tags": [
    "production",
    "team-alpha"
  ]
}

Response

Feedback for this request_id was already recorded.

feedback_idstring required

ID of the stored feedback.

already_submittedboolean required

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

request_idstring nullable required

Unique ID of this request, also in the X-Request-Id header. Include it when contacting support.

Changes

Changed in 1 of the 27 revisions of this API.1