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

# Annuler un lot

> Arrête le travail sur les éléments en file d’attente d’un lot. Les éléments déjà en cours d’exécution peuvent encore se terminer.

> [!NOTE]
>
> **Tu as remarqué la faute de frappe juste après avoir envoyé ?** Ça arrive aux meilleurs d'entre nous. Annule le lot, et tu ne paies que pour les éléments qui se terminent avec succès.
>
> * **Déjà terminé :** Facturé. Ces résultats sont prêts et t'attendent.
> * **Toujours en file d'attente :** Jamais exécuté, jamais facturé. C'est là que se trouvent les économies.
> * **En cours d'exécution :** Tu ne paies que pour les éléments réussis, comme d'habitude.
>
> Les crédits déjà dépensés ne sont pas remboursés, mais le reste de ton lot cesse de te coûter quoi que ce soit.

> [!TIP]
>
> **Après l'annulation :** Le lot peut encore afficher `in_progress` jusqu'à ce que les éléments en cours se terminent ou expirent. Vérifie la progression avec [Infos sur le lot](https://docs.olostep.com/api-reference/batches/info.md). L'annulation peut être appelée à nouveau en toute sécurité sur le même lot.


## OpenAPI

````yaml fr/openapi/batches.json POST /v1/batches/{batch_id}/cancel
openapi: 3.0.3
info:
  title: API des lots
  version: 1.0.0
servers:
  - url: https://api.olostep.com
security: []
paths:
  /v1/batches/{batch_id}/cancel:
    post:
      summary: Annuler un lot
      description: >-
        Annule les éléments **en file d'attente** d'un lot. Les éléments déjà en
        cours peuvent encore se terminer. Aucun corps de requête n'est requis.
        Appeler à nouveau l'annulation sur le même lot est sans danger : les
        éléments déjà annulés ne sont pas comptés à nouveau.
      parameters:
        - name: batch_id
          in: path
          required: true
          schema:
            type: string
          description: L'ID du lot à annuler.
      responses:
        '200':
          description: Résumé d'annulation pour l'ensemble du lot.
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                    description: Total des éléments dans le lot.
                  done_count:
                    type: integer
                    description: Éléments déjà terminés ou annulés avant cet appel.
                  in_flight_count:
                    type: integer
                    description: >-
                      Éléments déjà en cours d'exécution. Ils ne sont pas
                      annulés.
                  canceled_count:
                    type: integer
                    description: Éléments en file d'attente annulés par cet appel.
                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: Les informations d'authentification sont manquantes ou invalides.
          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: Clé API invalide ou manquante
                detail: The provided API key is invalid.
                created: 1704067200
                metadata: {}
        '404':
          description: >-
            Lot non trouvé pour l'ID fourni, ou il appartient à une autre
            équipe.
          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: lot non trouvé
                detail: No batch with id 'YOUR_BATCH_ID' exists for your team.
                created: 1704067200
                metadata: {}
        '409':
          description: >-
            La date limite du lot est passée, donc l'annulation n'est plus
            autorisée.
          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: Conflit de ressource
                detail: The batch deadline has passed.
                created: 1704067200
                metadata: {}
        '500':
          description: >-
            Erreur interne du serveur. Voir [Erreur
            interne](/api-reference/errors/internal_error) pour plus de détails.
          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: Erreur Interne du Serveur
                detail: An unexpected error occurred
                created: 1704067200
                metadata: {}
      security:
        - Authorization: []
components:
  schemas:
    Error:
      type: object
      description: Réponse d'erreur Détails du problème RFC 7807
      properties:
        id:
          type: string
          description: Identifiant d'erreur unique
        object:
          type: string
          enum:
            - error
          description: Toujours 'error'
        code:
          type: string
          description: Code d'erreur lisible par machine
        type:
          type: string
          format: uri
          description: Référence URI identifiant le type de problème
        status:
          type: integer
          description: Code de statut HTTP
        title:
          type: string
          description: Résumé court et lisible par l'homme
        detail:
          type: string
          description: Explication lisible par l'homme
        created:
          type: integer
          description: Horodatage Unix
        metadata:
          $ref: '#/components/schemas/Metadata'
        errors:
          type: array
          description: Tableau optionnel de détails d'erreur supplémentaires
          items: {}
      required:
        - id
        - object
        - code
        - type
        - status
        - title
        - detail
        - created
    Metadata:
      type: object
      description: >-
        Ensemble de paires clé-valeur pour stocker des informations
        supplémentaires sur un objet. Suit l'approche de Stripe avec des règles
        de validation : max 50 clés, clé max 40 caractères (pas de crochets),
        valeur max 500 caractères, toutes les valeurs stockées en tant que
        chaînes.
      additionalProperties:
        type: string
        maxLength: 500
        description: >-
          Valeur de métadonnées (max 500 caractères). Les nombres et les
          booléens sont automatiquement convertis en chaînes.
      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: >-
        En-tête d'authentification Bearer de la forme Bearer <token>, où <token>
        est ton jeton d'authentification.

````

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