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

# Informations sur le lot

> Récupère le statut et les informations de progression d’un lot. Pour récupérer le contenu d’un lot, voir [ici](/api-reference/batches/items)

<Tip>
  **Joindre des données personnalisées :** Utilisez le paramètre `metadata` pour stocker des paires clé-valeur avec votre lot. Voir [Métadonnées](/api-reference/common/metadata) pour plus de détails.
</Tip>


## OpenAPI

````yaml fr/openapi/batches.json GET /v1/batches/{batch_id}
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}:
    get:
      summary: Récupérer les informations du lot
      description: >-
        Récupère les informations sur un lot spécifique en utilisant son
        `batch_id`.
      parameters:
        - name: batch_id
          in: path
          required: true
          schema:
            type: string
          description: L'ID du lot pour lequel récupérer les informations.
      responses:
        '200':
          description: Réponse réussie avec les informations du lot.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: ID du lot
                  object:
                    type: string
                    description: Le type d'objet. "batch" pour ce point de terminaison.
                  status:
                    type: string
                    description: '`in_progress` ou `completed`'
                  created:
                    type: number
                    description: Époque créée
                  total_urls:
                    type: number
                    description: Nombre d'URLs dans le lot
                  completed_urls:
                    type: number
                    description: Nombre d'URLs complétées
                  parser:
                    type: string
                  country:
                    type: string
                  metadata:
                    $ref: '#/components/schemas/Metadata'
                  webhook:
                    type: string
                    description: URL de webhook pour recevoir la notification de fin
                  credits_consumed:
                    type: integer
                    nullable: true
                    description: >-
                      Nombre de crédits consommés par cette requête. Rempli
                      après l'exécution terminée. Les crédits sont la source de
                      vérité pour la facturation.
                  cost_usd:
                    type: number
                    nullable: true
                    description: >-
                      Coût estimé en USD pour cette requête. Rempli après
                      l'exécution terminée. Calculé à partir des crédits
                      consommés et de ton tarif de plan — 99% précis, mais
                      credits_consumed est la valeur faisant autorité.
        '401':
          description: >-
            Les informations d'authentification sont manquantes ou invalides.
            Voir [Non autorisé](/api-reference/errors/unauthorized) pour plus de
            détails.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                id: error_abc123
                object: error
                code: invalid_api_key
                type: https://docs.olostep.com/api-reference/errors/unauthorized
                status: 401
                title: Non autorisé
                detail: Your API key is invalid
                created: 1704067200
                metadata: {}
        '404':
          description: >-
            Lot non trouvé pour l'ID fourni. Voir [Non
            Trouvé](/api-reference/errors/not_found) pour plus de détails.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                id: error_abc123
                object: error
                code: batch_not_found
                type: https://docs.olostep.com/api-reference/errors/not_found
                status: 404
                title: Non Trouvé
                detail: Batch not found
                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:
    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 des 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)
    Error:
      type: object
      description: Réponse d'erreur RFC 7807 Détails du Problème
      properties:
        id:
          type: string
          description: Identifiant unique de l'erreur
        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 un humain
        detail:
          type: string
          description: Explication lisible par un humain
        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
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer
      description: >-
        En-tête d'authentification Bearer sous la forme Bearer <token>, où
        <token> est ton jeton d'authentification.

````