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

# Annulla Batch

> Interrompe il lavoro sugli elementi in coda di un batch. Gli elementi già in esecuzione potrebbero comunque terminare.

> [!NOTE]
>
> **Hai notato l'errore di battitura subito dopo aver inviato?** Succede anche ai migliori. Annulla il batch e paghi solo per gli elementi che completano con successo.
>
> * **Già completati:** Fatturati. Questi risultati sono pronti e ti aspettano.
> * **Ancora in coda:** Mai eseguiti, mai fatturati. Qui risiedono i risparmi.
> * **Attualmente in esecuzione:** Paghi solo per gli elementi di successo, come al solito.
>
> I crediti già spesi non vengono rimborsati, ma il resto del tuo batch smette di costarti qualcosa.

> [!TIP]
>
> **Dopo aver annullato:** Il batch può ancora mostrare `in_progress` fino a quando gli elementi in esecuzione non terminano o scadono. Controlla i progressi con [Batch Info](https://docs.olostep.com/api-reference/batches/info.md). È sicuro richiamare di nuovo Annulla sullo stesso batch.


## OpenAPI

````yaml it/openapi/batches.json POST /v1/batches/{batch_id}/cancel
openapi: 3.0.3
info:
  title: API dei Batch
  version: 1.0.0
servers:
  - url: https://api.olostep.com
security: []
paths:
  /v1/batches/{batch_id}/cancel:
    post:
      summary: Annulla un batch
      description: >-
        Annulla gli elementi **in coda** di un batch. Gli elementi già in
        esecuzione potrebbero comunque terminare. Non è richiesto un corpo della
        richiesta. Chiamare di nuovo l'annullamento sullo stesso batch è sicuro:
        gli elementi già annullati non vengono contati di nuovo.
      parameters:
        - name: batch_id
          in: path
          required: true
          schema:
            type: string
          description: L'ID del batch da annullare.
      responses:
        '200':
          description: Riepilogo dell'annullamento per l'intero batch.
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                    description: Totale degli elementi nel batch.
                  done_count:
                    type: integer
                    description: >-
                      Elementi già completati o annullati prima di questa
                      chiamata.
                  in_flight_count:
                    type: integer
                    description: Elementi già in esecuzione. Non vengono annullati.
                  canceled_count:
                    type: integer
                    description: Elementi in coda annullati da questa chiamata.
                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: Credenziali di autenticazione mancanti o non valide.
          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: Chiave API non valida o mancante
                detail: The provided API key is invalid.
                created: 1704067200
                metadata: {}
        '404':
          description: Batch non trovato per l'ID fornito, o appartiene a un altro 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 non trovato
                detail: No batch with id 'YOUR_BATCH_ID' exists for your team.
                created: 1704067200
                metadata: {}
        '409':
          description: >-
            La scadenza del batch è passata, quindi l'annullamento non è più
            consentito.
          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: Conflitto di risorse
                detail: The batch deadline has passed.
                created: 1704067200
                metadata: {}
        '500':
          description: >-
            Errore interno del server. Vedi [Errore
            Interno](/api-reference/errors/internal_error) per i dettagli.
          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: Errore Interno del Server
                detail: An unexpected error occurred
                created: 1704067200
                metadata: {}
      security:
        - Authorization: []
components:
  schemas:
    Error:
      type: object
      description: Risposta di errore Dettagli Problema RFC 7807
      properties:
        id:
          type: string
          description: Identificatore univoco dell'errore
        object:
          type: string
          enum:
            - error
          description: Sempre 'error'
        code:
          type: string
          description: Codice di errore leggibile dalla macchina
        type:
          type: string
          format: uri
          description: Riferimento URI che identifica il tipo di problema
        status:
          type: integer
          description: Codice di stato HTTP
        title:
          type: string
          description: Breve riassunto leggibile dall'uomo
        detail:
          type: string
          description: Spiegazione leggibile dall'uomo
        created:
          type: integer
          description: Timestamp Unix
        metadata:
          $ref: '#/components/schemas/Metadata'
        errors:
          type: array
          description: Array opzionale di dettagli aggiuntivi sull'errore
          items: {}
      required:
        - id
        - object
        - code
        - type
        - status
        - title
        - detail
        - created
    Metadata:
      type: object
      description: >-
        Insieme di coppie chiave-valore per memorizzare informazioni aggiuntive
        su un oggetto. Segue l'approccio di Stripe con regole di validazione:
        massimo 50 chiavi, chiave massimo 40 caratteri (senza parentesi quadre),
        valore massimo 500 caratteri, tutti i valori memorizzati come stringhe.
      additionalProperties:
        type: string
        maxLength: 500
        description: >-
          Valore dei metadati (max 500 caratteri). Numeri e booleani sono
          automaticamente convertiti in stringhe.
      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: >-
        Intestazione di autenticazione Bearer del tipo Bearer <token>, dove
        <token> è il tuo token di autenticazione.

````

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