> ## 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 indienen

> Vertel ons wanneer de API iets fout heeft gedaan. Kost geen credits.

Gebruik dit eindpunt wanneer een resultaat onjuist, onvolledig, traag, mislukt was, of niet overeenkwam met de documentatie. Het is bedoeld om zowel door agenten als door mensen aangeroepen te worden: wanneer je pipeline een slecht resultaat detecteert, rapporteer het dan met de `id` van het object waar het vandaan kwam, zodat we het kunnen herleiden naar het exacte verzoek.

Feedback indienen is gratis en het werkt zelfs wanneer de credits van je team op zijn.

## Wat te verzenden

| Veld | Vereist | Opmerkingen |
| - | - | - |
| `category` | ja | Een van `output_quality`, `reliability`, `performance`, `documentation`, `api_usability`, `feature_gap`, `other` |
| `note` | ja | Wat er misging en wat je in plaats daarvan verwachtte, tot 4.000 tekens |
| `issues` | nee | Tot 20 `snake_case` symptoomcodes, zoals `missing_content` of `timeout`. De gedocumenteerde codes staan vermeld in het schema; elke andere code van dezelfde vorm wordt geaccepteerd |
| `affected_endpoint` | nee | `METHOD /path`, bijvoorbeeld `POST /v1/scrapes` |
| `related_object_id` | nee | De `id` van de scrape, batch, crawl, antwoord, of ander object waar de feedback over gaat, of de `error_…` id wanneer de oproep is mislukt |
| `url` | nee | De pagina waar de feedback over gaat, zoals de URL die werd gescraped |

## Voorbeeld

```bash cURL theme={null}
curl -X POST https://api.olostep.com/v1/feedbacks \
  -H "Authorization: Bearer <your_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "category": "output_quality",
    "issues": ["missing_content", "broken_formatting"],
    "note": "De markdown laat de prijstabelvergelijking weg; verwachtte alle 4 rijen.",
    "affected_endpoint": "POST /v1/scrapes",
    "related_object_id": "scrape_abc1234567",
    "url": "https://example.com/pricing"
  }'
```

De respons is het opgeslagen `feedback` object met zijn `id` en `created_at`. Er is nog geen lijst- of ophaal-eindpunt; feedback wordt aan onze kant gelezen.


## OpenAPI

````yaml nl/openapi/feedbacks.json POST /v1/feedbacks
openapi: 3.0.3
info:
  title: Feedbacks API
  version: 1.0.0
  description: >-
    Meld een probleem met de Olostep API: verkeerde of onvolledige output, een
    fout, een documentatieverschil, of een ontbrekende mogelijkheid. Kost geen
    credits.
servers:
  - url: https://api.olostep.com
security:
  - Authorization: []
paths:
  /v1/feedbacks:
    post:
      summary: Feedback indienen
      description: >-
        Meld een probleem met de API. Voeg de id van het object waar de feedback
        over gaat toe wanneer je die hebt. Kost geen credits.
      operationId: createFeedback
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FeedbackCreateRequest'
      responses:
        '200':
          description: De opgeslagen feedback.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Feedback'
        '400':
          description: De body is ongeldig.
        '401':
          description: De API-sleutel ontbreekt of is ongeldig.
components:
  schemas:
    FeedbackCreateRequest:
      type: object
      required:
        - category
        - note
      properties:
        category:
          type: string
          enum:
            - output_quality
            - reliability
            - performance
            - documentation
            - api_usability
            - feature_gap
            - other
          description: De algemene reden voor de feedback.
        note:
          type: string
          minLength: 1
          maxLength: 4000
          description: Wat er misging en wat je in plaats daarvan verwachtte.
          example: >-
            The markdown drops the pricing comparison table; expected all 4
            rows.
        issues:
          type: array
          maxItems: 20
          items:
            type: string
            pattern: ^[a-z0-9](?:[a-z0-9_]{0,78}[a-z0-9])?$
          description: >-
            Specifieke symptomen, als lowercase snake_case codes.
            Gedocumenteerde codes: 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. Elke andere code van dezelfde vorm wordt
            geaccepteerd.
          example:
            - missing_content
            - broken_formatting
        affected_endpoint:
          type: string
          minLength: 1
          maxLength: 200
          description: >-
            De endpoint waar de feedback over gaat, als `METHOD /path` met het
            canonieke meervoudige pad.
          example: POST /v1/scrapes
        related_object_id:
          type: string
          minLength: 1
          maxLength: 128
          description: >-
            De id van het object dat de API retourneerde waar de feedback over
            gaat: een scrape_…, batch_… of vergelijkbare resource id, of de id
            van het foutobject (error_…) wanneer de oproep mislukte.
          example: scrape_abc1234567
        url:
          type: string
          format: uri
          maxLength: 2048
          description: >-
            De pagina waar de feedback over gaat, zoals de URL die werd
            gescraped.
          example: https://example.com/pricing
    Feedback:
      type: object
      required:
        - object
        - id
        - category
        - issues
        - note
        - created_at
      properties:
        object:
          type: string
          enum:
            - feedback
        id:
          type: string
          example: feedback_019e70f9-214a-74fc-a1ae-26fd3318be3e
        category:
          type: string
        issues:
          type: array
          items:
            type: string
        note:
          type: string
        affected_endpoint:
          type: string
        related_object_id:
          type: string
        url:
          type: string
        created_at:
          type: string
          format: date-time
          example: '2026-10-23T00:00:00.000Z'
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer
      description: >-
        Bearer authenticatie header in de vorm Bearer <token>, waar <token> jouw
        auth token is.

````

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