> ## Documentation Index > Fetch the complete documentation index at: https://docs.runpulse.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Batch Status > Get a batch's status, with its documents counted by state. A batch ends `completed`, `failed` or `canceled` within 48 hours of being sent. Once it ends, read its manifest at `GET /parse/batch/{batch_id}/result`. ## OpenAPI ````yaml /api-reference/v2/openapi.yml get /parse/batch/{batch_id} openapi: 3.1.0 info: title: Pulse API description: >- Agentic document infrastructure for the enterprise. The Pulse API turns complex documents into AI-ready data, such as Markdown, structured JSON and bounding boxes. version: '2' servers: - url: https://api.runpulse.com description: Default Pulse API base URL security: [] tags: - name: Parse description: Parse a document's text, tables and figures. - name: Batch parse description: Parse many documents with one config. - name: Extract description: Extract structured data from a parsed document. - name: Split description: Find each topic's pages in a parsed document. - name: Tables description: Merge a parsed document's tables across pages. - name: Charts description: Read the charts in a parsed document. - name: Classify description: Sort a document into the categories you define. - name: Pipeline description: Run a parse and its follow-on steps as one job. - name: Usage description: Check the pages and credits your organization has used. - name: Webhook description: Get notified when your organization's jobs change status. - name: Organization settings description: Read and change your organization's name, address and default API version. paths: /parse/batch/{batch_id}: get: tags: - Batch parse summary: Get Batch Status description: >- Get a batch's status, with its documents counted by state. A batch ends `completed`, `failed` or `canceled` within 48 hours of being sent. Once it ends, read its manifest at `GET /parse/batch/{batch_id}/result`. operationId: getBatchStatus parameters: - name: batch_id in: path required: true schema: type: string description: The `batch_id` that `POST /parse/batch` returned. title: Batch Id description: The `batch_id` that `POST /parse/batch` returned. - name: Pulse-Version in: header required: false schema: type: string default: '2' title: Pulse-Version examples: default: value: '2' responses: '200': description: The batch's status, with its documents counted by state. content: application/json: schema: $ref: '#/components/schemas/BatchStatusResponse' '400': description: >- An unknown query parameter was sent ([`REQUEST_INVALID`](https://docs.runpulse.com/errors/request-invalid)). `Pulse-Version` names a version this API doesn't serve ([`UNSUPPORTED_VERSION`](https://docs.runpulse.com/errors/unsupported-version)). content: application/problem+json: schema: $ref: '#/components/schemas/Problem' application/json: schema: $ref: '#/components/schemas/Problem' headers: X-Request-Id: description: The request's id; the problem's `request_id`. schema: type: string x-pulse-errors: - REQUEST_INVALID - UNSUPPORTED_VERSION '401': description: >- No API key was sent, or it isn't valid ([`CREDENTIALS_INVALID`](https://docs.runpulse.com/errors/credentials-invalid)), or it's inactive and needs replacing with a new key ([`API_KEY_INACTIVE`](https://docs.runpulse.com/errors/api-key-inactive)). content: application/problem+json: schema: $ref: '#/components/schemas/Problem' application/json: schema: $ref: '#/components/schemas/Problem' headers: X-Request-Id: description: The request's id; the problem's `request_id`. schema: type: string x-pulse-errors: - CREDENTIALS_INVALID - API_KEY_INACTIVE '403': content: application/problem+json: schema: $ref: '#/components/schemas/Problem' application/json: schema: $ref: '#/components/schemas/Problem' description: >- Your account is suspended ([`ACCOUNT_SUSPENDED`](https://docs.runpulse.com/errors/account-suspended)). headers: X-Request-Id: description: The request's id; the problem's `request_id`. schema: type: string x-pulse-errors: - ACCOUNT_SUSPENDED '404': description: >- No batch with this id exists in your organization ([`RESOURCE_NOT_FOUND`](https://docs.runpulse.com/errors/resource-not-found)). You get the same response for another organization's batch and for an id that isn't a batch id. No endpoint answers this path ([`ROUTE_NOT_FOUND`](https://docs.runpulse.com/errors/route-not-found)). content: application/problem+json: schema: $ref: '#/components/schemas/Problem' application/json: schema: $ref: '#/components/schemas/Problem' headers: X-Request-Id: description: The request's id; the problem's `request_id`. schema: type: string x-pulse-errors: - RESOURCE_NOT_FOUND - ROUTE_NOT_FOUND '500': description: >- An unexpected error occurred ([`SERVER_ERROR`](https://docs.runpulse.com/errors/server-error)). Retry the request. content: application/problem+json: schema: $ref: '#/components/schemas/Problem' application/json: schema: $ref: '#/components/schemas/Problem' headers: X-Request-Id: description: The request's id; the problem's `request_id`. schema: type: string x-pulse-errors: - SERVER_ERROR '503': description: >- The batch couldn't be read just now ([`SERVICE_UNAVAILABLE`](https://docs.runpulse.com/errors/service-unavailable)). Retry the request. On a self-hosted deployment, [`LICENSE_NOT_ACTIVATED`](https://docs.runpulse.com/errors/license-not-activated) until the deployment is activated. content: application/problem+json: schema: $ref: '#/components/schemas/Problem' application/json: schema: $ref: '#/components/schemas/Problem' headers: X-Request-Id: description: The request's id; the problem's `request_id`. schema: type: string Retry-After: description: Seconds to wait before retrying. schema: type: string x-pulse-errors: - SERVICE_UNAVAILABLE - LICENSE_NOT_ACTIVATED security: - ApiKey: [] components: schemas: BatchStatusResponse: properties: batch_id: type: string title: Batch Id description: The batch's id, `batch-`. summary: $ref: '#/components/schemas/BatchSummary' description: How many of the batch's documents are in each state. created_at: type: string title: Created At description: When the batch was accepted. status: type: string enum: - processing - completed - failed - canceled title: Status description: >- `completed`: every job ended and not all failed. `failed`: every job failed, it passed 48 hours, or it was interrupted (once its jobs end, resend the documents missing from the manifest). `canceled`: you canceled it. completed_at: type: string title: Completed At description: >- When the batch ended. Absent while it runs. After a failure or a cancel, its jobs can still end later. expires_at: type: string title: Expires At description: >- Never set, because a batch and its manifest don't expire. Each job's own status gives its `expires_at`. error: $ref: '#/components/schemas/Problem' description: Why the batch failed. Present only when `failed`. additionalProperties: false type: object required: - batch_id - summary - created_at - status title: BatchStatusResponse description: A batch's status, with its documents counted by state. Problem: additionalProperties: false description: >- Why the request or the job failed. Branch on `code`; quote `request_id` to support. properties: type: description: 'This code''s page: what it means and what to do.' title: Type type: string title: description: A short summary of the code, the same for every occurrence. title: Title type: string status: description: The HTTP status the code answers with. title: Status type: integer detail: description: What happened this time. title: Detail type: string instance: description: 'This occurrence: the request''s URN, `urn:pulse:request:`.' title: Instance type: string code: description: The stable error code, e.g. `REQUEST_INVALID`. Branch on it. title: Code type: string request_id: description: >- The request that failed, as `X-Request-Id` named it; for a failed job, the request that created it. Quote it to support. title: Request Id type: string retryable: description: Whether the same request may succeed if sent again. title: Retryable type: boolean retry_after: description: Seconds to wait before retrying, as `Retry-After` says. title: Retry After type: integer errors: description: Each refused part of the request. items: $ref: '#/components/schemas/FieldIssue' title: Errors type: array resource: description: 'What wasn''t found: `job`, `batch`, `webhook`, `config`, …' title: Resource type: string reason: description: The cause within the code. title: Reason type: string parse_id: description: The parse the request recorded. title: Parse Id type: string extract_id: description: The extraction it recorded. title: Extract Id type: string split_id: description: The split it recorded. title: Split Id type: string classify_id: description: The classification it recorded. title: Classify Id type: string tables_id: description: The tables job it recorded. title: Tables Id type: string charts_id: description: The charts job it recorded. title: Charts Id type: string pipeline_id: description: The pipeline it recorded. title: Pipeline Id type: string batch_id: description: The batch it recorded. title: Batch Id type: string filename: description: The file refused. title: Filename type: string declared_type: description: The type its name declared. title: Declared Type type: string detected: description: The type its contents are. title: Detected type: string supported_types: description: The types accepted. items: type: string title: Supported Types type: array supported: description: The values accepted. items: type: string title: Supported type: array max_size_mb: anyOf: - type: integer - type: number description: The largest size accepted. title: Max Size Mb file_size_mb: anyOf: - type: integer - type: number description: The file's size. title: File Size Mb plan_name: description: Your organization's plan. title: Plan Name type: string pages_used: anyOf: - type: integer - type: number description: Pages used this period. title: Pages Used page_allowance: anyOf: - type: integer - type: number description: Pages the plan allows. title: Page Allowance upgrade_url: description: Where to change your plan. title: Upgrade Url type: string action_required: description: What to do to continue. title: Action Required type: string billing_info: additionalProperties: $ref: '#/components/schemas/JsonValue' description: Your organization's billing state, as the gate read it. title: Billing Info type: object required: - type - title - status - code - retryable title: Problem type: object BatchSummary: properties: queued: type: integer title: Queued description: Documents whose job hasn't started yet. processing: type: integer title: Processing description: Documents whose job is running. completed: type: integer title: Completed description: >- Documents whose job completed. They're still counted after the result expires. failed: type: integer title: Failed description: >- Documents whose job failed, including any that a job couldn't be created for. Those have no manifest entry. canceled: type: integer title: Canceled description: >- Documents whose job was canceled, whether with the batch, on its own, or when the batch ran out of time. expired: type: integer title: Expired description: >- Documents whose result expired before the batch counted them as ended. This is rare. total: type: integer title: Total description: >- The number of documents in the batch, not counting skipped unsupported files. The other counts add up to it once every job is created. additionalProperties: false type: object required: - queued - processing - completed - failed - canceled - expired - total title: BatchSummary description: How many of a batch's documents are in each state. FieldIssue: additionalProperties: false description: One refused part of the request. properties: field: description: >- The part as sent: a body field's path (`config.enhancements.detect[1]`), or `query.` / `header.`. title: Field type: string pointer: description: >- A body field as a JSON Pointer (RFC 6901), e.g. `#/config/enhancements/detect/1`. Absent for a query parameter or header. title: Pointer type: string issue: description: What is wrong with it. title: Issue type: string required: - field - issue title: FieldIssue type: object JsonValue: {} securitySchemes: ApiKey: type: apiKey in: header name: x-api-key ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.