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

# Read a batch

> Every job of the batch with its state (queued, running, done, failed) and, when done, its result, plus counts by state.



## OpenAPI

````yaml scripts/api/sources/openapi.json GET /batches/{batchId}
openapi: 3.1.0
info:
  title: Summer API
  version: '1'
  description: >-
    Curated, tested game-dev models: 3D, images, video, voice, sound and music,
    into your Summer assets.
servers:
  - url: https://www.summerengine.com/v1
security:
  - bearer: []
paths:
  /batches/{batchId}:
    get:
      summary: Read a batch
      description: >-
        Every job of the batch with its state (queued, running, done, failed)
        and, when done, its result, plus counts by state.
      operationId: batches_get
      parameters:
        - name: batchId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The batch.
          content:
            application/json:
              schema:
                type: object
                properties:
                  batch:
                    type: object
                    properties:
                      id:
                        type: string
                      estimatedPrice:
                        type: string
                      createdAt:
                        type: string
                      counts:
                        type: object
                        additionalProperties:
                          type: integer
                        description: How many jobs are in each state.
                      jobs:
                        type: array
                        items:
                          type: object
                          description: >-
                            Each job as GET /v1/jobs/{jobId} answers it: id,
                            state, model, estimatedPrice, price once known,
                            result once done.
        default:
          description: An error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - type
            - code
            - message
            - param
            - request_id
            - doc_url
          properties:
            type:
              type: string
            code:
              type: string
              description: >-
                A stable code: invalid_input, not_signed_in, no_credits (the
                paid balance), over_limit (the app's own spend limit), ...
            message:
              type: string
            param:
              type:
                - string
                - 'null'
              description: The field to fix, such as input.prompt or Idempotency-Key.
            request_id:
              type: string
            doc_url:
              type: string
            fix_url:
              type: string
              description: Where the person fixes it, such as adding credits.
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        A Summer sign-in: an OAuth 2.1 access token, valid one hour. Sign in
        once with npx -y summer-engine login, then print a token with summer
        token. Each app you sign in spends your paid credits up to the limit you
        set in Connected apps.

````

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