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

# Get Batch Status

> Check the progress of a scoring batch and its individual jobs

Get the current status of a scoring batch, the scoring jobs it contains, and any applications rejected during batch intake.

## Batch status values

| Status      | Meaning                                                                                                                |
| ----------- | ---------------------------------------------------------------------------------------------------------------------- |
| `pending`   | Batch isn't finished yet. Jobs may be queued or currently scoring                                                      |
| `completed` | All jobs completed successfully                                                                                        |
| `failed`    | Batch finished and at least one job failed. Use `failedJobs` and `completedJobs` to determine partial vs total failure |

`totalJobs`, `completedJobs`, and `failedJobs` count accepted applications only. `rejectedApplications` were rejected before queueing, so they do not create scoring jobs and do not emit `score.failed` webhooks.

## Example response

```json theme={null}
{
  "batch": {
    "id": "cmlz26em4002cwp61t7ukh3lb",
    "jobId": "job-123",
    "status": "pending",
    "totalJobs": 2,
    "completedJobs": 1,
    "failedJobs": 0,
    "createdAt": "2025-12-14T10:30:45Z",
    "completedAt": null
  },
  "scoringJobs": [
    {
      "id": "cmlz26dl3001bwp61r8sjf2ka",
      "criteriaVersionId": "cmlz26ck2000awp61q9qcjcne",
      "jobId": "job-123",
      "applicationId": "app-001",
      "status": "completed",
      "isRescore": false,
      "score": 7,
      "assessment": {
        "verdict": "Strong candidate with solid backend experience.",
        "strengths": [],
        "concerns": [],
        "interviewFocus": []
      },
      "errorCode": null,
      "errorMessage": null,
      "queuedAt": "2025-12-14T10:30:45Z",
      "startedAt": "2025-12-14T10:30:50Z",
      "completedAt": "2025-12-14T10:31:20Z",
      "failedAt": null
    }
  ],
  "rejectedApplications": [
    {
      "applicationId": "app-bad",
      "error": {
        "code": "RESUME_CORRUPTED",
        "message": "Resume file appears to be corrupted",
        "reason": "missing_eof"
      }
    }
  ]
}
```


## OpenAPI

````yaml GET /v1/jobs/{jobId}/scoring-batches/{scoringBatchId}
openapi: 3.1.0
info:
  title: Nova Embed API
  description: >-
    The Nova Embed API enables ATS platforms to generate job-scoped screening
    criteria and score applications asynchronously against those criteria.
  version: 1.0.0
  contact:
    name: Nova Support
    email: nova@dweet.com
servers:
  - url: https://embed.nova.dweet.com
    description: >-
      Environment is determined by API key prefix: sk_test_* for sandbox,
      sk_live_* for production.
security:
  - bearerAuth: []
tags:
  - name: Analytics
    description: View scoring performance, webhook health, and error breakdowns.
  - name: Criteria
    description: Generate and manage job-scoped screening criteria.
  - name: Scoring
    description: Submit applications for scoring and fetch scoring job results.
  - name: Deletion
    description: Request application or tenant deletion and poll for completion.
  - name: Criteria Library
    description: Manage tenant-scoped reusable criteria templates.
  - name: Rate Limits
    description: Check your current rate limit status.
  - name: Webhooks
    description: >-
      Events sent to your registered webhook endpoints. Verify signatures with
      HMAC-SHA256 using your webhook secret.
paths:
  /v1/jobs/{jobId}/scoring-batches/{scoringBatchId}:
    get:
      tags:
        - Scoring
      summary: Get scoring batch status
      operationId: getScoringBatch
      parameters:
        - $ref: '#/components/parameters/TenantId'
        - $ref: '#/components/parameters/JobId'
        - $ref: '#/components/parameters/ScoringBatchId'
      responses:
        '200':
          description: Batch status
          headers:
            X-RateLimit-Bucket:
              $ref: '#/components/headers/X-RateLimit-Bucket'
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBatchStatusResponse'
        '401':
          $ref: '#/components/responses/ErrorResponse'
        '404':
          $ref: '#/components/responses/ErrorResponse'
        '429':
          $ref: '#/components/responses/RateLimitedResponse'
        '500':
          $ref: '#/components/responses/ErrorResponse'
      x-codeSamples:
        - lang: typescript
          label: '@nova-sdk/api'
          source: |-
            import { Nova } from "@nova-sdk/api";

            const nova = new Nova({
              apiKey: "sk_test_...",
              tenantId: "acme-corp",
            });

            const result = await nova.jobs.scoringBatches.getStatus({
              jobId: "job_abc123",
              scoringBatchId: "sb_abc123",
            });
        - lang: bash
          label: cURL
          source: >-
            curl -X GET
            "https://embed.nova.dweet.com/v1/jobs/job_abc123/scoring-batches/sb_abc123"
            \
              -H "Authorization: Bearer sk_test_..." \
              -H "X-Tenant-Id: acme-corp"
components:
  parameters:
    TenantId:
      name: X-Tenant-Id
      in: header
      required: true
      description: Your customer identifier. Tenants are auto-provisioned on first request.
      schema:
        type: string
      example: acme-corp
    JobId:
      name: jobId
      in: path
      required: true
      description: Your job identifier (external ID).
      schema:
        type: string
    ScoringBatchId:
      name: scoringBatchId
      in: path
      required: true
      description: Scoring batch ID.
      schema:
        type: string
  headers:
    X-RateLimit-Bucket:
      description: Which rate limit bucket the request was classified into
      schema:
        type: string
        enum:
          - criteria_ai
          - criteria_current_reads
          - scoring_intake_batch
          - scoring_intake_single
          - read_and_ops
          - rate_limit_status
          - analytics
    X-RateLimit-Limit:
      description: Maximum requests per second for this bucket
      schema:
        type: integer
    X-RateLimit-Remaining:
      description: Requests remaining in the current 1-second window
      schema:
        type: integer
    X-RateLimit-Reset:
      description: Unix timestamp when the current window resets
      schema:
        type: integer
    Retry-After:
      description: >-
        Seconds to wait before retrying a short-window RATE_LIMITED or
        service-unavailable response whose body has retryable: true.
      schema:
        type: integer
    X-RateLimit-Degraded:
      description: >-
        Present and set to "true" when rate limiting is operating in degraded
        mode (Redis unavailable). Values in other rate limit headers are
        best-effort estimates.
      schema:
        type: string
        enum:
          - 'true'
  schemas:
    GetBatchStatusResponse:
      type: object
      required:
        - batch
        - scoringJobs
        - rejectedApplications
      properties:
        batch:
          $ref: '#/components/schemas/Batch'
        scoringJobs:
          type: array
          items:
            $ref: '#/components/schemas/ScoringJob'
        rejectedApplications:
          type: array
          items:
            $ref: '#/components/schemas/BatchRejectedApplication'
    Batch:
      type: object
      required:
        - id
        - jobId
        - status
        - totalJobs
        - completedJobs
        - failedJobs
        - createdAt
        - completedAt
      properties:
        id:
          type: string
        jobId:
          type: string
        status:
          $ref: '#/components/schemas/BatchStatus'
        totalJobs:
          type: integer
        completedJobs:
          type: integer
        failedJobs:
          type: integer
        createdAt:
          type: string
          format: date-time
        completedAt:
          type:
            - string
            - 'null'
          format: date-time
    ScoringJob:
      type: object
      required:
        - id
        - criteriaVersionId
        - jobId
        - applicationId
        - status
        - isRescore
        - score
        - assessment
        - errorCode
        - errorMessage
        - queuedAt
        - startedAt
        - completedAt
        - failedAt
      properties:
        id:
          type: string
        criteriaVersionId:
          type: string
          description: >-
            The criteria version snapshot used for scoring. Fetch the snapshot
            via GET /v1/jobs/{jobId}/criteria/versions/{criteriaVersionId}.
        jobId:
          type: string
        applicationId:
          type: string
        status:
          $ref: '#/components/schemas/ScoringJobStatus'
        isRescore:
          type: boolean
        score:
          type:
            - number
            - 'null'
        assessment:
          oneOf:
            - $ref: '#/components/schemas/Assessment'
            - type: 'null'
        errorCode:
          oneOf:
            - $ref: '#/components/schemas/ErrorCode'
            - type: 'null'
        errorMessage:
          type:
            - string
            - 'null'
        queuedAt:
          type: string
          format: date-time
        startedAt:
          type:
            - string
            - 'null'
          format: date-time
        completedAt:
          type:
            - string
            - 'null'
          format: date-time
        failedAt:
          type:
            - string
            - 'null'
          format: date-time
    BatchRejectedApplication:
      type: object
      required:
        - applicationId
        - error
      properties:
        applicationId:
          type: string
        error:
          type: object
          required:
            - code
            - message
            - reason
          properties:
            code:
              $ref: '#/components/schemas/ErrorCode'
            message:
              type: string
            reason:
              type:
                - string
                - 'null'
    HttpError:
      type: object
      required:
        - type
        - code
        - status
        - message
        - retryable
        - traceId
      properties:
        type:
          type: string
          description: URI reference that identifies the error type
        code:
          $ref: '#/components/schemas/ErrorCode'
        status:
          type: integer
          description: HTTP status code
        message:
          type: string
          description: Error message
        retryable:
          type: boolean
          description: When true, retrying the request may succeed
        traceId:
          type: string
          description: Trace ID for debugging
        details:
          type:
            - array
            - 'null'
          description: Field-level validation details
          items:
            type: object
            required:
              - field
              - code
              - message
            properties:
              field:
                type: string
              code:
                type: string
              message:
                type: string
    BatchStatus:
      type: string
      enum:
        - pending
        - completed
        - failed
    ScoringJobStatus:
      type: string
      enum:
        - pending
        - completed
        - failed
    Assessment:
      type: object
      required:
        - verdict
        - strengths
        - concerns
        - interviewFocus
      properties:
        verdict:
          type: string
        strengths:
          type: array
          items:
            type: string
        concerns:
          type: array
          items:
            type: string
        interviewFocus:
          type: array
          items:
            type: string
    ErrorCode:
      type: string
      description: >-
        Machine-readable error code. Generated from the canonical error
        registry.
      enum:
        - UNAUTHORIZED
        - FORBIDDEN
        - VALIDATION_ERROR
        - ANSWER_MISMATCH
        - CRITERIA_INVALID
        - CRITERIA_REVISION_CONFLICT
        - NOT_FOUND
        - TENANT_NOT_FOUND
        - JOB_NOT_FOUND
        - APPLICATION_NOT_FOUND
        - QUESTION_SET_NOT_FOUND
        - CRITERIA_NOT_FOUND
        - CRITERION_NOT_FOUND
        - CRITERIA_VERSION_NOT_FOUND
        - SCORING_JOB_NOT_FOUND
        - BATCH_NOT_FOUND
        - LIBRARY_CRITERION_NOT_FOUND
        - RATE_LIMITED
        - MONTHLY_TRIAL_QUOTA_EXCEEDED
        - IDEMPOTENCY_KEY_ALREADY_USED
        - IDEMPOTENCY_REQUEST_IN_PROGRESS
        - RESUME_FETCH_FAILED
        - RESUME_CONVERSION_FAILED
        - RESUME_ENCRYPTED
        - RESUME_CORRUPTED
        - RESUME_PARSE_FAILED
        - RESUME_TOO_LARGE
        - RESUME_EMPTY
        - RESUME_URL_BLOCKED
        - AI_PROCESSING_FAILED
        - AI_GENERATION_FAILED
        - AI_SCORING_FAILED
        - MISSING_JOB_DESCRIPTION
        - TIMEOUT
        - MAX_RETRIES_EXCEEDED
        - TASK_STUCK
        - DELETION_REQUEST_NOT_FOUND
        - DELETION_REQUEST_FAILED
        - INTERNAL_ERROR
        - SERVICE_UNAVAILABLE
        - UNKNOWN
  responses:
    ErrorResponse:
      description: Error response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/HttpError'
    RateLimitedResponse:
      description: >-
        Too many requests. Short-window RATE_LIMITED responses include retry
        timing and rate limit headers. Monthly trial quota responses use
        MONTHLY_TRIAL_QUOTA_EXCEEDED with retryable: false.
      headers:
        Retry-After:
          $ref: '#/components/headers/Retry-After'
        X-RateLimit-Bucket:
          $ref: '#/components/headers/X-RateLimit-Bucket'
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
        X-RateLimit-Degraded:
          $ref: '#/components/headers/X-RateLimit-Degraded'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/HttpError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: 'Use Authorization: Bearer sk_test_* or Authorization: Bearer sk_live_*.'

````