---
title: "Feedback API"
description: "Report a failed call, wrong or missing data, or ask for an API we do not have. Free, with or without an API key; read our reply by the report's id."
---

> Every apinoa docs page as markdown: https://apinoa.com/llms.txt (all in one file: https://apinoa.com/llms-full.txt; this API family in one file: https://apinoa.com/docs/feedback/llms.txt)

```http
POST /v1/feedback
GET  /v1/feedback/{id}
```

Tell us when a call fails, returns a wrong value, leaves out something the page shows, or when the platform,
operation or option you need does not exist. It is free and works **without an API key**, so an AI agent can
send it the moment it hits the problem. Send your key and the report is linked to your account, which lets us
look at the exact call you name in `requestId`.

Every report gets an id. Its status and our reply are at `GET /v1/feedback/{id}`. Give an email address in
`contact`, or send your key, and the reply is also emailed to you.

## Send feedback

```bash tab="cURL"
curl -X POST "https://gateway.apinoa.com/v1/feedback" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "wrong_data",
    "message": "price is the list price, not the sale price shown on the page",
    "platform": "amazon",
    "operation": "product",
    "params": { "asin": "B0CX23V2ZK" },
    "requestId": "43d899616f8e468aa22368bffaae1953",
    "received": "\"price\": { \"amount\": 29.99 }",
    "expected": "24.99",
    "contact": "dev@example.com"
  }'
```

```js tab="JavaScript"
const res = await fetch("https://gateway.apinoa.com/v1/feedback", {
  method: "POST",
  // Add "x-api-key" to link the report to your account.
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    type: "feature_request",
    message: "Etsy listings and reviews, with the same fields as a Shopify product.",
    contact: "dev@example.com",
  }),
});
const { data } = await res.json(); // { id, status, createdAt }
```

```python tab="Python"
import os

import requests

res = requests.post(
    "https://gateway.apinoa.com/v1/feedback",
    headers={"x-api-key": os.environ["APINOA_API_KEY"]},
    json={
        "type": "error",
        "message": "tiktok posts with a hashtag has answered 502 every time since this morning",
        "platform": "tiktok",
        "operation": "posts",
        "params": {"hashtag": "glassskin"},
        "requestId": "43d899616f8e468aa22368bffaae1953",
    },
    timeout=30,
)
body = res.json()
```

## Parameters

**Headers**

| Header | Required | Notes |
|---|---|---|
| `Content-Type` | | `application/json`. |
| `x-api-key` | | Your API key, to link the report to your account. Leave it out to send feedback anonymously; a key that is sent must be valid. |

**Body**, a JSON object of at most 64 KB:

| Field | Type | Required | Notes |
|---|---|---|---|
| `type` | string | yes | One of the types below. |
| `message` | string | yes | What happened, or what you need, in your own words. Up to 4,000 characters. |
| `platform` | string | | The platform, as in the path: `amazon`, `tiktok`, `google`… |
| `operation` | string | | The operation, as in the path: `search`, `product`, `posts`… |
| `params` | object | | The parameters you sent. Up to 8 KB. |
| `requestId` | string | | The `requestId` of the response you are reporting. Sent with your key, it lets us look at that call. |
| `url` | string | | A page that shows the right data, or the item the report is about. |
| `received` | any | | The part of the response that is wrong: text, or the JSON value as you got it. Up to 16 KB. |
| `expected` | any | | What it should have been: text or a JSON value. Up to 4,000 characters. |
| `contact` | string | | An email address for our reply. |
| `source` | string | | What sent it, such as your agent's or app's name. Up to 32 characters. |

| `type` | Use it when | Include |
|---|---|---|
| `error` | A call failed or behaved wrongly. | `platform`, `operation`, `params`, `requestId`, and the error you got in `received`. |
| `wrong_data` | A field holds the wrong value. | The same, plus `expected`, or a `url` that shows the right value. |
| `missing_data` | Something the page shows is not in the response. | The same, and the `url` of the page. |
| `feature_request` | You need a platform, operation, field or option we do not have. | What you would call and what you would get back, in `message`. |
| `other` | Anything else. | |

## Response

A new report answers `201 Created`:

```json
{
  "success": true,
  "data": {
    "id": "fb_6f1c2a9e0b4d4e7f8a3b5c1d2e9f0a7b",
    "status": "received",
    "createdAt": "2026-11-11T10:00:00Z"
  }
}
```

The same `type` and `message` sent again within a day, with the same key (or without a key, from the same
sender), returns the first report with `200 OK` rather than creating another.

## Read the Status and Reply

```bash
curl "https://gateway.apinoa.com/v1/feedback/fb_6f1c2a9e0b4d4e7f8a3b5c1d2e9f0a7b"
```

No key is needed: the id is enough. Nothing you sent is returned, only our side:

```json
{
  "success": true,
  "data": {
    "id": "fb_6f1c2a9e0b4d4e7f8a3b5c1d2e9f0a7b",
    "type": "wrong_data",
    "status": "resolved",
    "reply": "Fixed: product now returns the sale price. Retry the call.",
    "repliedAt": "2026-11-12T08:30:00Z",
    "createdAt": "2026-11-11T10:00:00Z",
    "updatedAt": "2026-11-12T08:30:00Z"
  }
}
```

| Field | Type | Meaning |
|---|---|---|
| `status` | string | `received`, then `in_progress` while we work on it, then `resolved` or `declined`. |
| `reply` | string \| null | Our answer, or `null` until we reply. |
| `repliedAt` | string \| null | When we replied. |
| `createdAt`, `updatedAt` | string | When the report arrived and last changed. |

## SDKs and MCP

- **TypeScript**: `client.feedback.send({ type, message, ... })` and `client.feedback.get({ id })`. To send
  without a key, build the client with `new ApinoaClient({ auth: false })`.
- **Python**: `client.feedback.send(type=..., message=..., request_id=...)` and `client.feedback.get(id)`.
- **MCP**: the `send_feedback` and `get_feedback` tools. They work without a key.

## Errors

| Status | Code | Meaning |
|---|---|---|
| 400 | `BAD_REQUEST` | The body is not a JSON object with `type` and `message`, or a field is invalid; the message names it. |
| 401 | `UNAUTHORIZED` | An `x-api-key` was sent, but the key is invalid or revoked. Leave it out to send without one. |
| 404 | `NOT_FOUND` | No feedback has this id. |
| 413 | `PAYLOAD_TOO_LARGE` | The body is over 64 KB. |
| 429 | `RATE_LIMITED` | Too many reports from one sender. Wait the `Retry-After` seconds. |
| 503 | `SERVICE_UNAVAILABLE` | The report could not be saved just now. Retry shortly. |

## Limits and Pricing

- **Free.** Feedback is never billed, with or without a key.
- **Rate.** Without a key, 10 reports an hour and 50 a day from one sender; with a key, 30 an hour per key.
  Without a key a `429` can also come at busy times; a report sent with your key is not affected.
- **What we keep.** The report, and the email address if you give one, are kept so we can answer and fix
  what you report. See the [privacy policy](/privacy).
