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

# Cancelar Lote

> Detiene el trabajo en los elementos en cola de un lote. Los elementos que ya están en ejecución pueden aún terminar.

> [!NOTE]
>
> **¿Notaste el error tipográfico justo después de enviar?** Nos pasa a los mejores. Cancela el lote y solo pagas por los elementos que se completan con éxito.
>
> * **Ya finalizados:** Facturados. Estos resultados están listos y esperando por ti.
> * **Aún en la cola:** Nunca ejecutados, nunca facturados. Aquí es donde se encuentran los ahorros.
> * **Ejecutándose ahora mismo:** Solo pagas por los elementos exitosos, como de costumbre.
>
> Los créditos ya gastados no se reembolsan, pero el resto de tu lote deja de costarte algo.

> [!TIP]
>
> **Después de cancelar:** El lote aún puede mostrar `in_progress` hasta que los elementos en ejecución terminen o se agoten. Verifica el progreso con [Información del Lote](https://docs.olostep.com/api-reference/batches/info.md). Es seguro llamar a cancelar nuevamente en el mismo lote.


## OpenAPI

````yaml es/openapi/batches.json POST /v1/batches/{batch_id}/cancel
openapi: 3.0.3
info:
  title: API de Lotes
  version: 1.0.0
servers:
  - url: https://api.olostep.com
security: []
paths:
  /v1/batches/{batch_id}/cancel:
    post:
      summary: Cancelar un lote
      description: >-
        Cancela los elementos **en cola** de un lote. Los elementos que ya están
        en ejecución pueden aún terminar. No se requiere cuerpo de solicitud.
        Llamar a cancelar de nuevo en el mismo lote es seguro: los elementos que
        ya están cancelados no se cuentan de nuevo.
      parameters:
        - name: batch_id
          in: path
          required: true
          schema:
            type: string
          description: El ID del lote a cancelar.
      responses:
        '200':
          description: Resumen de cancelación para todo el lote.
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                    description: Total de elementos en el lote.
                  done_count:
                    type: integer
                    description: >-
                      Elementos ya terminados o cancelados antes de esta
                      llamada.
                  in_flight_count:
                    type: integer
                    description: Elementos ya en ejecución. No se cancelan.
                  canceled_count:
                    type: integer
                    description: Elementos en cola cancelados por esta llamada.
                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: Las credenciales de autenticación faltan o son inválidas.
          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: Clave de API inválida o faltante
                detail: The provided API key is invalid.
                created: 1704067200
                metadata: {}
        '404':
          description: >-
            Lote no encontrado para el ID proporcionado, o pertenece a otro
            equipo.
          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: lote no encontrado
                detail: No batch with id 'YOUR_BATCH_ID' exists for your team.
                created: 1704067200
                metadata: {}
        '409':
          description: >-
            La fecha límite del lote ha pasado, por lo que ya no se permite
            cancelar.
          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: Conflicto de recursos
                detail: The batch deadline has passed.
                created: 1704067200
                metadata: {}
        '500':
          description: >-
            Error interno del servidor. Consulta [Internal
            Error](/api-reference/errors/internal_error) para más detalles.
          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: Error Interno del Servidor
                detail: An unexpected error occurred
                created: 1704067200
                metadata: {}
      security:
        - Authorization: []
components:
  schemas:
    Error:
      type: object
      description: Respuesta de error de Detalles del Problema RFC 7807
      properties:
        id:
          type: string
          description: Identificador único de error
        object:
          type: string
          enum:
            - error
          description: Siempre 'error'
        code:
          type: string
          description: Código de error legible por máquina
        type:
          type: string
          format: uri
          description: Referencia URI que identifica el tipo de problema
        status:
          type: integer
          description: Código de estado HTTP
        title:
          type: string
          description: Resumen corto y legible por humanos
        detail:
          type: string
          description: Explicación legible por humanos
        created:
          type: integer
          description: Marca de tiempo Unix
        metadata:
          $ref: '#/components/schemas/Metadata'
        errors:
          type: array
          description: Array opcional de detalles adicionales del error
          items: {}
      required:
        - id
        - object
        - code
        - type
        - status
        - title
        - detail
        - created
    Metadata:
      type: object
      description: >-
        Conjunto de pares clave-valor para almacenar información adicional sobre
        un objeto. Sigue el enfoque de Stripe con reglas de validación: máximo
        50 claves, clave máximo 40 caracteres (sin corchetes), valor máximo 500
        caracteres, todos los valores almacenados como cadenas.
      additionalProperties:
        type: string
        maxLength: 500
        description: >-
          Valor de metadatos (máximo 500 caracteres). Los números y booleanos se
          convierten automáticamente a cadenas.
      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: >-
        Encabezado de autenticación Bearer del formulario Bearer <token>, donde
        <token> es tu token de autenticación.

````

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