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

> Stoppt die Bearbeitung der in der Warteschlange befindlichen Elemente eines Batches. Elemente, die bereits laufen, können dennoch fertiggestellt werden.

> [!NOTE]
>
> **Den Tippfehler direkt nach dem Absenden bemerkt?** Das passiert den Besten. Brich den Batch ab, und du zahlst nur für die Elemente, die erfolgreich abgeschlossen werden.
>
> * **Bereits abgeschlossen:** Abgerechnet. Diese Ergebnisse sind fertig und warten auf dich.
> * **Noch in der Warteschlange:** Nie ausgeführt, nie abgerechnet. Hier liegen die Einsparungen.
> * **Gerade in Bearbeitung:** Du zahlst nur für erfolgreiche Elemente, wie gewohnt.
>
> Bereits ausgegebene Credits werden nicht erstattet, aber der Rest deines Batches kostet dich nichts mehr.

> [!TIP]
>
> **Nach dem Abbrechen:** Der Batch kann weiterhin als `in_progress` angezeigt werden, bis die laufenden Elemente abgeschlossen sind oder ablaufen. Überprüfe den Fortschritt mit [Batch Info](https://docs.olostep.com/api-reference/batches/info.md). Das Abbrechen kann sicher erneut für denselben Batch aufgerufen werden.


## OpenAPI

````yaml de/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: Einen Batch abbrechen
      description: >-
        Bricht die **wartenden** Elemente eines Batches ab. Bereits laufende
        Elemente können noch abgeschlossen werden. Kein Anfragetext
        erforderlich. Ein erneuter Abbruchaufruf für denselben Batch ist sicher:
        Bereits abgebrochene Elemente werden nicht erneut gezählt.
      parameters:
        - name: batch_id
          in: path
          required: true
          schema:
            type: string
          description: Die ID des Batches, der abgebrochen werden soll.
      responses:
        '200':
          description: Abbruchzusammenfassung für den gesamten Batch.
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                    description: Gesamte Elemente im Batch.
                  done_count:
                    type: integer
                    description: >-
                      Elemente, die bereits vor diesem Aufruf abgeschlossen oder
                      abgebrochen wurden.
                  in_flight_count:
                    type: integer
                    description: Bereits laufende Elemente. Sie werden nicht abgebrochen.
                  canceled_count:
                    type: integer
                    description: >-
                      Wartende Elemente, die durch diesen Aufruf abgebrochen
                      wurden.
                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: Authentifizierungsdaten fehlen oder sind ungültig.
          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: Ungültiger oder fehlender API-Schlüssel
                detail: The provided API key is invalid.
                created: 1704067200
                metadata: {}
        '404':
          description: >-
            Batch für die angegebene ID nicht gefunden oder gehört zu einem
            anderen 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 nicht gefunden
                detail: No batch with id 'YOUR_BATCH_ID' exists for your team.
                created: 1704067200
                metadata: {}
        '409':
          description: >-
            Die Frist für den Batch ist abgelaufen, daher ist ein Abbruch nicht
            mehr erlaubt.
          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: Ressourcenkonflikt
                detail: The batch deadline has passed.
                created: 1704067200
                metadata: {}
        '500':
          description: >-
            Interner Serverfehler. Siehe [Internal
            Error](/api-reference/errors/internal_error) für 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: Interner Serverfehler
                detail: An unexpected error occurred
                created: 1704067200
                metadata: {}
      security:
        - Authorization: []
components:
  schemas:
    Error:
      type: object
      description: RFC 7807 Problem Details Fehlerantwort
      properties:
        id:
          type: string
          description: Eindeutige Fehlerkennung
        object:
          type: string
          enum:
            - error
          description: Immer 'error'
        code:
          type: string
          description: Maschinenlesbarer Fehlercode
        type:
          type: string
          format: uri
          description: URI-Referenz, die den Problemtyp identifiziert
        status:
          type: integer
          description: HTTP-Statuscode
        title:
          type: string
          description: Kurze, menschenlesbare Zusammenfassung
        detail:
          type: string
          description: Menschenlesbare Erklärung
        created:
          type: integer
          description: Unix-Zeitstempel
        metadata:
          $ref: '#/components/schemas/Metadata'
        errors:
          type: array
          description: Optionale Liste zusätzlicher Fehlerdetails
          items: {}
      required:
        - id
        - object
        - code
        - type
        - status
        - title
        - detail
        - created
    Metadata:
      type: object
      description: >-
        Satz von Schlüssel-Wert-Paaren zur Speicherung zusätzlicher
        Informationen über ein Objekt. Folgt dem Ansatz von Stripe mit
        Validierungsregeln: maximal 50 Schlüssel, Schlüssel maximal 40 Zeichen
        (keine eckigen Klammern), Wert maximal 500 Zeichen, alle Werte werden
        als Strings gespeichert.
      additionalProperties:
        type: string
        maxLength: 500
        description: >-
          Metadatenwert (maximal 500 Zeichen). Zahlen und Booleans werden
          automatisch in Strings umgewandelt.
      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-Authentifizierungsheader in der Form Bearer <token>, wobei
        <token> dein Authentifizierungstoken ist.

````

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