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

# Get Export Status

> Poll for the current state of a PDF export job. While the job is running, `state` is `processing`, `progressPercent` advances from 0 to 100, and `exportUrl` is `null`. When `state === "completed"`, `exportUrl` becomes a presigned download URL (expires 10 minutes after this response — re-poll to get a fresh URL).

If `state === "failed"`, `exportUrl` stays `null`, the export will not complete, and a new one must be kicked off.



## OpenAPI

````yaml api/openapi.json GET /v1/exports/{exportId}
openapi: 3.1.0
info:
  title: Connections Hub API
  version: 1.0.0
  description: >-
    Run HSS Connections Hub calculators programmatically: create projects,
    create and solve sheets from any calculator template, run batches, and
    export reports to PDF.


    All endpoints require API key authentication.
servers:
  - url: https://api.calcs.com
security:
  - bearerAuth: []
tags:
  - name: Projects
    description: >-
      Create and manage calculation projects. Each user can have multiple
      projects to organize their calculations.
  - name: Sheets
    description: >-
      Manage individual calculation sheets — read one back, update its inputs,
      solve or re-solve it, and delete single sheets or clean up many at once.
  - name: Templates
    description: >-
      Run calculations using any enabled template. Supports all calculator types
      without requiring endpoint-specific code.
paths:
  /v1/exports/{exportId}:
    get:
      tags:
        - Projects
      summary: Get Export Status
      description: >-
        Poll for the current state of a PDF export job. While the job is
        running, `state` is `processing`, `progressPercent` advances from 0 to
        100, and `exportUrl` is `null`. When `state === "completed"`,
        `exportUrl` becomes a presigned download URL (expires 10 minutes after
        this response — re-poll to get a fresh URL).


        If `state === "failed"`, `exportUrl` stays `null`, the export will not
        complete, and a new one must be kicked off.
      operationId: get-export
      parameters:
        - name: Authorization
          in: header
          required: true
          example: Bearer YOUR_KEY_HERE
          schema:
            type: string
          description: >-
            The `Authorization` header is used to authenticate with the API
            using your API key. Value is of the format `Bearer YOUR_KEY_HERE`.
        - name: exportId
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Export ID returned from `POST /v1/projects/{projectId}/export`
      responses:
        '200':
          description: Current export status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportStatus'
              examples:
                processing:
                  summary: Still rendering — poll again; exportUrl is null
                  value:
                    exportId: 662f0b28-3c2e-4dae-a61b-1bdfa367373b
                    state: processing
                    progressPercent: 45
                    exportUrl: null
                completed:
                  summary: Ready — download from exportUrl within 10 minutes
                  value:
                    exportId: 662f0b28-3c2e-4dae-a61b-1bdfa367373b
                    state: completed
                    progressPercent: 100
                    exportUrl: >-
                      https://clearcalcs-exports.s3.amazonaws.com/exports/662f0b28-3c2e-4dae-a61b-1bdfa367373b.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=600&X-Amz-Signature=EXAMPLE
                failed:
                  summary: >-
                    Export failed — progressPercent is frozen wherever it
                    stopped, exportUrl stays null; start a new export
                  value:
                    exportId: 662f0b28-3c2e-4dae-a61b-1bdfa367373b
                    state: failed
                    progressPercent: 50
                    exportUrl: null
        '401':
          description: Unauthorized — missing or invalid API key.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              examples:
                unauthorized:
                  summary: Missing or invalid API key
                  value:
                    type: https://httpproblems.com/http-status/401
                    title: Unauthorized
                    status: 401
                    detail: No Authorization Header
                    instance: /v1/exports/662f0b28-3c2e-4dae-a61b-1bdfa367373b
                    trace:
                      timestamp: '2026-07-03T04:24:41.646Z'
                      requestId: 782427e6-6a0f-4d4d-84cf-ffcc8dd38731
                      buildId: 2bca24cd-6038-4608-b26c-a997deb070d3
                      rayId: a1531f3c39b6e6e1
        '404':
          description: Export not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                export_not_found:
                  summary: Export does not exist
                  value:
                    error:
                      code: NOT_FOUND
                      message: export not found
      security:
        - api_key: []
components:
  schemas:
    ExportStatus:
      type: object
      description: >-
        Async PDF export status. `exportUrl` is `null` while the export is
        `processing` or `failed`, and is populated with a presigned download URL
        only once `state === "completed"`; that URL then expires 10 minutes
        after each poll.
      properties:
        exportId:
          type: string
          format: uuid
        state:
          type: string
          enum:
            - processing
            - completed
            - failed
        progressPercent:
          type: number
          minimum: 0
          maximum: 100
        exportUrl:
          type:
            - string
            - 'null'
          format: uri
          description: >-
            Presigned S3 URL, or `null` while the export is still processing or
            has failed. Populated only once `state === "completed"`, after which
            it expires 10 minutes after this response.
      required:
        - exportId
        - state
        - progressPercent
        - exportUrl
    ProblemDetails:
      type: object
      description: >-
        RFC 7807 (`application/problem+json`) error returned by the API gateway
        before a request reaches the handler — currently authentication failures
        (401). Note this differs from the `{ error: { code, message, details }
        }` envelope returned by the handler for validation and not-found errors.
      properties:
        type:
          type: string
          format: uri
          description: URI identifying the problem type.
        title:
          type: string
          description: Short, human-readable summary of the problem type.
        status:
          type: integer
          description: HTTP status code.
        detail:
          type: string
          description: Human-readable explanation specific to this occurrence.
        instance:
          type: string
          description: The request path that produced the error.
        trace:
          type: object
          description: >-
            Gateway trace metadata for support (timestamp, requestId, buildId,
            rayId).
      required:
        - type
        - title
        - status
        - detail
    ErrorResponse:
      type: object
      description: >-
        Standard error envelope for handler errors. `code` is a stable
        machine-readable error code (e.g. NOT_FOUND, UPSTREAM_ERROR); `message`
        is human-readable and may change.
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Machine-readable error code.
            message:
              type: string
              description: Human-readable error message.
          required:
            - code
            - message
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Send your API key as a bearer token: `Authorization: Bearer
        YOUR_API_KEY`. Every endpoint requires one.
    api_key:
      type: http
      scheme: bearer

````

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