> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nimbleway.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get batch progress

> Retrieve lightweight progress information for a batch without fetching all task details.



## OpenAPI

````yaml /api-reference/openapi.json get /v2/batches/{batch_id}/progress
openapi: 3.1.0
info:
  title: Nimble SDK
  version: 1.0.0
  description: The AI-Native SDK for Real-Time Web Data at scale
servers:
  - url: https://sdk.nimbleway.com
security: []
paths:
  /v2/batches/{batch_id}/progress:
    get:
      tags:
        - Tasks
      summary: Get batch progress
      description: >-
        Retrieve lightweight progress information for a batch without fetching
        all task details.
      parameters:
        - description: The unique identifier of the batch.
          in: path
          name: batch_id
          required: true
          schema:
            description: The unique identifier of the batch.
            examples:
              - 123e4567-e89b-12d3-a456-426614174000
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchProgressResponse'
          description: Batch progress returned successfully.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskErrorResponse'
          description: Batch not found.
      security:
        - BearerAuth: []
components:
  schemas:
    BatchProgressResponse:
      additionalProperties: false
      description: Lightweight batch progress without task details.
      properties:
        completed:
          description: Whether all tasks in the batch have finished.
          type: boolean
        completed_at:
          description: ISO timestamp when the batch completed.
          type: string
        completed_count:
          description: Number of tasks that have completed so far.
          type: number
        id:
          description: Unique identifier for the batch.
          type: string
        progress:
          description: Completion ratio between 0 and 1.
          type: number
        status:
          const: success
          type: string
      required:
        - status
        - id
        - completed
        - completed_count
        - progress
      type: object
    TaskErrorResponse:
      additionalProperties: false
      description: Error response for task operations.
      properties:
        error:
          description: Error message describing what went wrong.
          examples:
            - task not found
          type: string
        status:
          const: failed
          description: Status indicating the request failed.
          type: string
      required:
        - status
        - error
      type: object
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````

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