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
  }
}
'
import requests

url = "https://api.example.com/v1/feedback"

payload = {
"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
}
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
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
}
})
};

fetch('https://api.example.com/v1/feedback', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/feedback",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/v1/feedback"

payload := strings.NewReader("{\n \"name\": \"Avery Developer\",\n \"company\": \"Example Energy Co\",\n \"feedback_type\": \"docs_issue\",\n \"summary\": \"Clarify the usage array shape for period bill impact\",\n \"message\": \"The period bill impact docs could state explicitly that each daily usage array needs 96 fifteen-minute values.\",\n \"page\": \"/api-reference/endpoint/homes/calculate-period-bill-impact\",\n \"endpoint\": \"/v1/homes/{id}/calculate/impact\",\n \"environment\": \"sandbox\",\n \"submitter\": {\n \"kind\": \"agent\",\n \"agent\": \"claude-code\",\n \"client\": \"cli\"\n },\n \"contact\": {\n \"email\": \"[email protected]\",\n \"preferred_contact\": \"email\",\n \"consent_to_contact\": true\n }\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/v1/feedback")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Avery Developer\",\n \"company\": \"Example Energy Co\",\n \"feedback_type\": \"docs_issue\",\n \"summary\": \"Clarify the usage array shape for period bill impact\",\n \"message\": \"The period bill impact docs could state explicitly that each daily usage array needs 96 fifteen-minute values.\",\n \"page\": \"/api-reference/endpoint/homes/calculate-period-bill-impact\",\n \"endpoint\": \"/v1/homes/{id}/calculate/impact\",\n \"environment\": \"sandbox\",\n \"submitter\": {\n \"kind\": \"agent\",\n \"agent\": \"claude-code\",\n \"client\": \"cli\"\n },\n \"contact\": {\n \"email\": \"[email protected]\",\n \"preferred_contact\": \"email\",\n \"consent_to_contact\": true\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/feedback")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Avery Developer\",\n \"company\": \"Example Energy Co\",\n \"feedback_type\": \"docs_issue\",\n \"summary\": \"Clarify the usage array shape for period bill impact\",\n \"message\": \"The period bill impact docs could state explicitly that each daily usage array needs 96 fifteen-minute values.\",\n \"page\": \"/api-reference/endpoint/homes/calculate-period-bill-impact\",\n \"endpoint\": \"/v1/homes/{id}/calculate/impact\",\n \"environment\": \"sandbox\",\n \"submitter\": {\n \"kind\": \"agent\",\n \"agent\": \"claude-code\",\n \"client\": \"cli\"\n },\n \"contact\": {\n \"email\": \"[email protected]\",\n \"preferred_contact\": \"email\",\n \"consent_to_contact\": true\n }\n}"

response = http.request(request)
puts response.read_body
{
  "feedback_id": "ws_feedback_123456789",
  "received": true,
  "follow_up": {
    "requested": true,
    "contact_method": "email"
  }
}
{
"request_id": "req_123",
"error_code": "VALIDATION_FAILED",
"message": "Request validation failed.",
"recovery_action": "Provide the x-ws-api-key header. If this contradicts the public docs, submit feedback through /v1/feedback.",
"field_errors": [
{
"message": "zipcode is invalid",
"field": "zipcode"
}
],
"retry_after_seconds": 3600
}
{
"request_id": "req_123",
"error_code": "VALIDATION_FAILED",
"message": "Request validation failed.",
"recovery_action": "Provide the x-ws-api-key header. If this contradicts the public docs, submit feedback through /v1/feedback.",
"field_errors": [
{
"message": "zipcode is invalid",
"field": "zipcode"
}
],
"retry_after_seconds": 3600
}

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