Skip to documentation
Weavers Docs

Pages and endpoints

Tab to navigate · Enter to openEsc to close

POST /api/product-feedback

Account required · HTTP API reference

All endpoints · Authentication and retries · Download OpenAPI

  • Requires a signed-in account and permission to access this resource. Use identifiers returned by your own account's earlier requests.
  • Message: 1–2,000 characters. Context contains a surface name and pathname only; do not include query strings or transcripts.
  • Protected writes require an allowed Origin, the CSRF cookie and matching X-CSRF-Token header.

Request

ParameterLocationType and requirement
x-idempotency-keyheaderstring · required

Pattern: ^[A-Za-z0-9_-]{8,128}$

Originheaderstring · required

An origin allowed by this deployment.

X-CSRF-Tokenheaderstring · required

Must match the CSRF cookie issued to this browser.

Body · application/json

message required · string
context required · object
View context model
surface required · string
pathname required · string

Example

Examples use fictional data. Replace identifiers with resources you can access. For account requests, cookies.txt must contain your own session; set CSRF_TOKEN to the matching CSRF cookie value where required.

Save as request.json
{
  "message": "The notebook save indicator could be clearer.",
  "context": {
    "surface": "eureka",
    "pathname": "/eureka"
  }
}
cURL (POSIX shell)
curl --include \
  --request POST \
  'https://api.weavers.app/api/product-feedback' \
  --cookie cookies.txt --cookie-jar cookies.txt \
  --header 'x-idempotency-key: example-request-0001' \
  --header 'Origin: https://weavers.app' \
  --header "X-CSRF-Token: ${CSRF_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data-binary @request.json

Responses

202 · Work accepted. Poll the returned job or request identifier.

application/json

202 example · synthetic data
{
  "id": "1",
  "status": "received",
  "createdAt": "2025-01-01T00:00:00.000Z"
}
View response model
id required · string
status required · "received"
createdAt required · string

Additional fields: JSON values.

400 · Invalid request.

application/json

400 example · synthetic data
{
  "code": "example",
  "error": "example"
}
View response model
Variant 1: object
code required · string
error required · string

Additional fields: JSON values.

401 · Authentication is missing or invalid.

application/json

401 example · synthetic data
{}
View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string
code optional · string
message optional · string

Additional fields: JSON values.

403 · Permission, origin or CSRF check failed.

application/json

403 example · synthetic data
{}
View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string
code optional · string
message optional · string

Additional fields: JSON values.

429 · Rate limit reached; honor Retry-After when supplied.

application/json

429 example · synthetic data
{}
View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string
code optional · string
message optional · string

Additional fields: JSON values.

500 · Server failure.

application/json

500 example · synthetic data
{}
View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string
code optional · string
message optional · string

Additional fields: JSON values.

503 · Service or dependency unavailable.

application/json

503 example · synthetic data
{
  "code": "example",
  "error": "example"
}
View response model
code required · string
error required · string

Additional fields: JSON values.

default · Operation-specific error. Inspect error/code before deciding whether to retry.

application/json

default example · synthetic data
{
  "code": "feedback_key_reused",
  "error": "example"
}
View response model
code required · "feedback_key_reused" | "feedback_rate_limited"
error required · string

Additional fields: JSON values.