Skip to main content
POST
/
v1
/
feedback
Submit structured feedback or a question
curl --request POST \
  --url https://api.example.com/v1/feedback \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Avery Developer",
  "company": "Example Energy Co",
  "feedback_type": "docs_issue",
  "summary": "Clarify the usage array shape for period bill impact",
  "message": "The period bill impact docs could state explicitly that each daily usage array needs 96 fifteen-minute values.",
  "page": "/api-reference/endpoint/homes/calculate-period-bill-impact",
  "endpoint": "/v1/homes/{id}/calculate/impact",
  "environment": "sandbox",
  "submitter": {
    "kind": "agent",
    "agent": "claude-code",
    "client": "cli"
  },
  "contact": {
    "email": "[email protected]",
    "preferred_contact": "email",
    "consent_to_contact": true
  }
}
'
{
  "feedback_id": "ws_feedback_123456789",
  "received": true,
  "follow_up": {
    "requested": true,
    "contact_method": "email"
  }
}

Body

application/json
name
string
Required string length: 1 - 255
company
string
Maximum string length: 255
message
string
Maximum string length: 4000
page
string
Maximum string length: 2048
feedback_type
enum<string>
default:other
Available options:
question,
docs_issue,
source_of_truth_disagreement,
blocked_build,
bug,
feature_request,
integration_request,
suggestion,
other
summary
string
Maximum string length: 500
question
string
Maximum string length: 4000
expected_behavior
string
Maximum string length: 4000
actual_behavior
string
Maximum string length: 4000
sanitized_evidence
any
error
any
repro_steps
string
Maximum string length: 4000
suggested_fix
string
Maximum string length: 4000
endpoint
string
Maximum string length: 255
operation_id
string
Maximum string length: 255
environment
string
Maximum string length: 64
request_id
string
Maximum string length: 128
docs_url
string<uri>
source_urls
string<uri>[]
Maximum array length: 10
routing_tags
object
inferred_owning_area
string
Maximum string length: 128
submitter
object
contact
object

Response

Feedback received

feedback_id
string
required
received
boolean
required
follow_up
object
required