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

# Batch Annuleren

> Stopt het werk aan de items in de wachtrij van een batch. Items die al draaien, kunnen nog steeds voltooid worden.

> [!NOTE]
>
> **Heb je de typfout ontdekt net nadat je op verzenden hebt gedrukt?** Het overkomt de besten van ons. Annuleer de batch en je betaalt alleen voor items die succesvol worden voltooid.
>
> * **Al voltooid:** Gefactureerd. Deze resultaten zijn klaar en wachten op je.
> * **Nog in de wachtrij:** Nooit uitgevoerd, nooit gefactureerd. Hier zit de besparing.
> * **Nu aan het draaien:** Je betaalt alleen voor succesvolle items, zoals gewoonlijk.
>
> Reeds uitgegeven credits worden niet terugbetaald, maar de rest van je batch kost je niets meer.

> [!TIP]
>
> **Na annulering:** De batch kan nog steeds `in_progress` tonen totdat de draaiende items voltooid zijn of een time-out hebben. Controleer de voortgang met [Batch Info](https://docs.olostep.com/api-reference/batches/info.md). Annuleren kan veilig opnieuw worden aangeroepen op dezelfde batch.


## OpenAPI

````yaml nl/openapi/batches.json POST /v1/batches/{batch_id}/cancel
openapi: 3.0.3
info:
  title: Batches API
  version: 1.0.0
servers:
  - url: https://api.olostep.com
security: []
paths:
  /v1/batches/{batch_id}/cancel:
    post:
      summary: Annuleer een batch
      description: >-
        Annuleert de **geplande** items van een batch. Items die al draaien
        kunnen nog steeds voltooid worden. Er is geen aanvraaglichaam nodig. Het
        opnieuw annuleren van dezelfde batch is veilig: items die al geannuleerd
        zijn worden niet opnieuw geteld.
      parameters:
        - name: batch_id
          in: path
          required: true
          schema:
            type: string
          description: De ID van de batch om te annuleren.
      responses:
        '200':
          description: Annuleer samenvatting voor de hele batch.
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                    description: Totale items in de batch.
                  done_count:
                    type: integer
                    description: >-
                      Items die al voltooid of geannuleerd zijn voor deze
                      oproep.
                  in_flight_count:
                    type: integer
                    description: Items die al draaien. Ze worden niet geannuleerd.
                  canceled_count:
                    type: integer
                    description: Geplande items geannuleerd door deze oproep.
                required:
                  - total_count
                  - done_count
                  - in_flight_count
                  - canceled_count
              example:
                total_count: 100
                done_count: 12
                in_flight_count: 3
                canceled_count: 87
        '401':
          description: Authenticatiegegevens ontbreken of zijn ongeldig.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                id: error_abc123
                object: error
                code: invalid_api_key
                type: https://docs.olostep.com/errors/invalid_api_key
                status: 401
                title: Ongeldige of ontbrekende API-sleutel
                detail: The provided API key is invalid.
                created: 1704067200
                metadata: {}
        '404':
          description: >-
            Batch niet gevonden voor de opgegeven ID, of het behoort tot een
            ander team.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                id: error_abc123
                object: error
                code: not_found
                type: https://docs.olostep.com/errors/not_found
                status: 404
                title: batch niet gevonden
                detail: No batch with id 'YOUR_BATCH_ID' exists for your team.
                created: 1704067200
                metadata: {}
        '409':
          description: >-
            De deadline van de batch is verstreken, dus annuleren is niet langer
            toegestaan.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                id: error_abc123
                object: error
                code: resource_conflict
                type: https://docs.olostep.com/errors/resource_conflict
                status: 409
                title: Hulpbronconflict
                detail: The batch deadline has passed.
                created: 1704067200
                metadata: {}
        '500':
          description: >-
            Interne serverfout. Zie [Internal
            Error](/api-reference/errors/internal_error) voor details.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                id: error_abc123
                object: error
                code: internal_server_error
                type: https://docs.olostep.com/api-reference/errors/internal_error
                status: 500
                title: Interne Serverfout
                detail: An unexpected error occurred
                created: 1704067200
                metadata: {}
      security:
        - Authorization: []
components:
  schemas:
    Error:
      type: object
      description: RFC 7807 Probleemdetails foutreactie
      properties:
        id:
          type: string
          description: Unieke foutidentificatie
        object:
          type: string
          enum:
            - error
          description: Altijd 'error'
        code:
          type: string
          description: Machineleesbare foutcode
        type:
          type: string
          format: uri
          description: URI-referentie die het probleemtype identificeert
        status:
          type: integer
          description: HTTP-statuscode
        title:
          type: string
          description: Korte, mensvriendelijke samenvatting
        detail:
          type: string
          description: Mensvriendelijke uitleg
        created:
          type: integer
          description: Unix-tijdstempel
        metadata:
          $ref: '#/components/schemas/Metadata'
        errors:
          type: array
          description: Optionele array van aanvullende foutdetails
          items: {}
      required:
        - id
        - object
        - code
        - type
        - status
        - title
        - detail
        - created
    Metadata:
      type: object
      description: >-
        Set van sleutel-waardeparen voor het opslaan van extra informatie over
        een object. Volgt de aanpak van Stripe met validatieregels: maximaal 50
        sleutels, sleutel maximaal 40 tekens (geen vierkante haken), waarde
        maximaal 500 tekens, alle waarden opgeslagen als strings.
      additionalProperties:
        type: string
        maxLength: 500
        description: >-
          Metadatawaarde (maximaal 500 tekens). Nummers en booleans worden
          automatisch omgezet naar strings.
      maxProperties: 50
      example:
        order_id: '12345'
        customer_name: John Doe
        priority: high
        processed: 'true'
      x-validation-rules:
        max_keys: 50
        key_max_length: 40
        key_forbidden_chars:
          - '['
          - ']'
        value_max_length: 500
        value_types:
          - string
          - number (coerced)
          - boolean (coerced)
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer
      description: >-
        Bearer authenticatie header in de vorm van Bearer <token>, waar <token>
        jouw auth token is.

````

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