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

# Get bulk job status

> Poll a bulk tent creation job for per-item progress, publication results, and credit accounting.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/bulk-jobs/{bulkJobId}
openapi: 3.1.0
info:
  title: Tented API
  version: 1.0.0
  description: >-
    The Tented public API: generate, publish, and manage AI-built web pages
    (tents), and run the email platform — contacts, reusable emails, one-time
    blasts, and triggered flows.


    ## Authentication

    Authenticate every request with a workspace API key: `Authorization: Bearer
    <api-key>`. Keys are created in **Workspace Settings → API Keys** and are
    scoped to a single workspace.


    ## Asynchronous work

    Tent generation, bulk creation, and email AI generation return `202
    Accepted` immediately. Poll the corresponding status endpoint (`GET
    /v1/tents/{tentId}`, `GET /v1/bulk-jobs/{bulkJobId}`, `GET
    /v1/emails/{emailId}/generations/{generationId}`) — no more than every 10
    seconds.


    ## Pagination

    Email listings use cursor pagination (`cursor`/`next_cursor`). Blast, flow,
    and member listings use page pagination (`page`/`limit` with a `pagination`
    object in the response).


    ## Conventions

    Request and response fields are snake_case, with two exceptions: analytics
    query parameters (`tentIdOrAlias`, `daysBack`) and segment rule trees
    (camelCase keys such as `listId` and `timeWindow`).
  contact:
    name: Tented Support
    email: support@tented.ai
servers:
  - url: https://api.tented.ai
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Tents
    description: >-
      Create, edit, publish, and manage AI-generated pages, including asset
      uploads and bulk creation.
  - name: Analytics
    description: Traffic analytics for single tents and the whole workspace.
  - name: Contacts
    description: >-
      Batch create, update, and delete contacts. Up to 25 items per request with
      per-item results.
  - name: Emails
    description: >-
      Reusable email content: AI generation, direct HTML edits, plain-text
      control, and approval.
  - name: Email Blasts
    description: >-
      One-time sends to an audience: compose, schedule, track engagement, export
      recipients.
  - name: Triggered Flows
    description: >-
      Multi-step automations that enroll contacts on triggers and move them
      through a step graph.
  - name: Contact Imports
  - name: Contact Fields
  - name: Contact Lists
  - name: Email Templates
  - name: Tent Templates
    description: >-
      Reusable, AI-editable tent layouts. Create from HTML or an existing tent,
      iterate with AI, approve, and clone. Approved tent templates seed new
      tents.
paths:
  /v1/bulk-jobs/{bulkJobId}:
    get:
      tags:
        - Tents
      summary: Get bulk job status
      description: >-
        Poll a bulk tent creation job for per-item progress, publication
        results, and credit accounting.
      operationId: get-bulk-job-status
      parameters:
        - name: bulkJobId
          in: path
          required: true
          schema:
            type: string
          description: Bulk job ID.
      responses:
        '200':
          description: Current job state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkJob'
        '400':
          description: >-
            Bad request — invalid parameters or request body. Validation
            failures include `details.issues` with per-field messages.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized — missing, malformed, revoked, or expired API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: >-
            Not found — the resource does not exist in the workspace tied to
            your API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    BulkJob:
      type: object
      properties:
        bulk_job_id:
          type: string
          description: Bulk job ID.
        status:
          type: string
          enum:
            - accepted
            - running
            - completed
            - completed_with_failures
            - failed
          description: >-
            Job state. `completed_with_failures` means at least one item failed
            after admission.
        template_id:
          type: string
          description: Template used for the batch.
        auto_publish:
          type: boolean
          description: Whether the batch publishes tents automatically.
        total:
          type: integer
          description: Total submitted items.
        queued:
          type: integer
          description: Accepted items waiting to generate.
        generating:
          type: integer
          description: Items currently generating.
        completed:
          type: integer
          description: Items completed successfully.
        failed:
          type: integer
          description: Items that failed after admission.
        items:
          type: array
          items:
            $ref: '#/components/schemas/BulkJobItem'
          description: Per-item status, in request order.
        credits:
          $ref: '#/components/schemas/BulkCredits'
        created_at:
          type: string
          format: date-time
          description: Job creation time.
        updated_at:
          type: string
          format: date-time
          description: Last job update.
      required:
        - bulk_job_id
        - status
        - items
    Error:
      type: object
      properties:
        error:
          type: string
          description: Human-readable error message.
        error_code:
          type: string
          description: >-
            Stable machine-readable error code (present on email, blast, flow,
            and related endpoints, e.g. `campaign_not_ready`,
            `generation_in_progress`).
        message:
          type: string
          description: Additional human-readable context (present on some tent endpoints).
        code:
          type: string
          description: >-
            Machine-readable code used by tent creation errors (e.g.
            `INVALID_PROMPT_INTENT`).
        details:
          type: object
          additionalProperties: true
          description: >-
            Additional error context. Validation errors include `issues`: an
            array of `{ path, message }` objects.
        limit:
          type: integer
          description: Plan limit that was hit (present on `429` publish-limit errors).
        current:
          type: integer
          description: >-
            Current usage against the limit (present on `429` publish-limit
            errors).
      required:
        - error
      description: >-
        Error response. All errors include `error`; the other fields vary by
        endpoint group.
    BulkJobItem:
      type: object
      properties:
        index:
          type: integer
          description: Zero-based position of the item in the original request.
        client_item_id:
          type: string
          description: Your reconciliation ID, echoed back when supplied.
        tent_id:
          type: string
          format: uuid
          description: Tent created for this item (accepted items only).
        tent_name:
          type: string
          description: Resolved tent name.
        custom_page_alias:
          type: string
          description: Requested alias, echoed back when supplied.
        status:
          type: string
          enum:
            - accepted
            - rejected
            - queued
            - generating
            - completed
            - failed
          description: Item state.
        publication_status:
          type: string
          enum:
            - pending
            - published
            - published_with_warnings
            - failed
          description: Publication state when `auto_publish` is enabled.
        published_url:
          type: string
          description: Public URL once published.
        error_code:
          type: string
          enum:
            - INVALID_ITEM
            - NOT_FOUND
            - INSUFFICIENT_CREDITS
          description: Rejection code.
        message:
          type: string
          description: Human-readable rejection or failure reason.
      required:
        - index
        - status
    BulkCredits:
      type: object
      properties:
        reserved:
          type: integer
          description: Credits reserved for the job.
        consumed:
          type: integer
          description: Credits consumed so far.
        refunded:
          type: integer
          description: Credits refunded for failed items.
        pending_reconciliation:
          type: integer
          description: Credits still reserved for unfinished items.
      description: Aggregate credit accounting for a bulk job.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Workspace API key, e.g. `Authorization: Bearer tented_...`. Create keys
        in Workspace Settings → API Keys.

````