> ## Documentation Index
> Fetch the complete documentation index at: https://docs.olostep.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Feedback

> Segnala un risultato API errato, incompleto o fallito. Non costa crediti.

Attraverso l'endpoint `/v1/feedbacks` di Olostep puoi segnalare quando l'API ha commesso un errore. Puoi chiamarlo da un agente o dal tuo codice quando un risultato è errato, incompleto, lento, fallito o non corrisponde alla documentazione.

* Invia l'`id` dell'oggetto a cui si riferisce il feedback in modo che possiamo risalire alla richiesta esatta
* Tagga il report con una categoria e codici sintomo opzionali
* Inviare feedback è gratuito e funziona anche quando i crediti del tuo team sono esauriti

Per i dettagli sull'API, consulta la [Riferimento API per l'invio di feedback](https://docs.olostep.com/api-reference/feedbacks/create.md).

## Invia feedback

`category` e `note` sono obbligatori. Includi `related_object_id` quando lo hai: un id risorsa `scrape_…`, `batch_…`, o simile, o l'id `error_…` quando la chiamata è fallita.

```python Python theme={null}
import requests
import json

API_KEY = "<YOUR_API_KEY>"

payload = {
    "category": "output_quality",
    "issues": ["missing_content", "broken_formatting"],
    "note": "Il markdown non include la tabella di confronto dei prezzi; ci si aspettava tutte e 4 le righe.",
    "affected_endpoint": "POST /v1/scrapes",
    "related_object_id": "scrape_abc1234567",
    "url": "https://example.com/pricing"
}

headers = {
    "Authorization": f"Bearer {API_KEY}",
    "Content-Type": "application/json"
}

response = requests.post(
    "https://api.olostep.com/v1/feedbacks",
    headers=headers,
    json=payload
)
print(json.dumps(response.json(), indent=2))
```

```js Node theme={null}
const res = await fetch('https://api.olostep.com/v1/feedbacks', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <YOUR_API_KEY>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    category: 'output_quality',
    issues: ['missing_content', 'broken_formatting'],
    note: 'Il markdown non include la tabella di confronto dei prezzi; ci si aspettava tutte e 4 le righe.',
    affected_endpoint: 'POST /v1/scrapes',
    related_object_id: 'scrape_abc1234567',
    url: 'https://example.com/pricing'
  })
})
console.log(await res.json())
```

```bash cURL theme={null}
curl -X POST https://api.olostep.com/v1/feedbacks \
  -H "Authorization: Bearer $OLOSTEP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "category": "output_quality",
    "issues": ["missing_content", "broken_formatting"],
    "note": "Il markdown non include la tabella di confronto dei prezzi; ci si aspettava tutte e 4 le righe.",
    "affected_endpoint": "POST /v1/scrapes",
    "related_object_id": "scrape_abc1234567",
    "url": "https://example.com/pricing"
  }'
```

### Risposta

La risposta è l'oggetto `feedback` memorizzato. Non c'è un endpoint per elenchi o recuperi; il feedback viene letto dal nostro lato.

```json theme={null}
{
  "object": "feedback",
  "id": "feedback_019e70f9-214a-74fc-a1ae-26fd3318be3e",
  "category": "output_quality",
  "issues": ["missing_content", "broken_formatting"],
  "note": "Il markdown non include la tabella di confronto dei prezzi; ci si aspettava tutte e 4 le righe.",
  "affected_endpoint": "POST /v1/scrapes",
  "related_object_id": "scrape_abc1234567",
  "url": "https://example.com/pricing",
  "created_at": "2026-10-23T00:00:00.000Z"
}
```

## Campi

| Campo | Obbligatorio | Note |
| - | - | - |
| `category` | sì | Uno tra `output_quality`, `reliability`, `performance`, `documentation`, `api_usability`, `feature_gap`, `other` |
| `note` | sì | Cosa è andato storto e cosa ti aspettavi invece, fino a 4.000 caratteri |
| `issues` | no | Fino a 20 codici sintomo in `snake_case`. I codici documentati sono elencati di seguito; qualsiasi altro codice della stessa forma è accettato |
| `affected_endpoint` | no | `METHOD /path` con il percorso plurale canonico, ad esempio `POST /v1/scrapes` |
| `related_object_id` | no | L'`id` dello scrape, batch, crawl, answer o altro oggetto, o l'id `error_…` quando la chiamata è fallita |
| `url` | no | La pagina a cui si riferisce il feedback, come l'URL che è stato scrappato |

### Codici di problema

`missing_content`, `incorrect_content`, `incomplete_content`, `broken_formatting`, `irrelevant_results`, `duplicate_results`, `stale_content`, `request_failed`, `timeout`, `slow_response`, `inconsistent_result`, `docs_mismatch`, `broken_example`, `confusing_schema`, `confusing_error`, `unsupported_website`, `unsupported_format`.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.