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

# Pause TAM Builder Job

> Pause a running TAM build at the next ICP-band boundary - **resumable** (unlike cancel, which is terminal). The job flips to a transient `pausing` state, the in-flight process finishes and is written, then it settles to `paused`. Delivered companies stay readable via the poll endpoint, and you are charged only for what's been delivered so far. Resume with `POST /api/v1/tam/build/{job_id}/resume`



## OpenAPI

````yaml agent-primitives/openapi.json POST /api/v1/tam/build/{job_id}/pause
openapi: 3.1.0
info:
  title: OpenFunnel Agent Primitives
  version: 1.0.0
servers:
  - url: https://api.openfunnel.dev
security: []
paths:
  /api/v1/tam/build/{job_id}/pause:
    post:
      tags:
        - Pause TAM Builder Job
      summary: Pause TAM Builder Job
      description: >-
        Pause a running TAM build at the next ICP-band boundary - **resumable**
        (unlike cancel, which is terminal). The job flips to a transient
        `pausing` state, the in-flight process finishes and is written, then it
        settles to `paused`. Delivered companies stay readable via the poll
        endpoint, and you are charged only for what's been delivered so far.
        Resume with `POST /api/v1/tam/build/{job_id}/resume`
      parameters:
        - name: job_id
          in: path
          required: true
          schema:
            type: string
            title: Job Id
          description: The `job_id` returned by the TAM build submit endpoint.
        - name: X-API-Key
          in: header
          required: true
          schema:
            type: string
            title: X-Api-Key
      responses:
        '200':
          description: Pause accepted; the job is now `pausing` (or already `paused`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TamBuildPauseResponse'
              example:
                job_id: 8a8e8a97-8192-48ff-849a-d8a96e949732
                status: pausing
                message: >-
                  Pause requested. The in-flight sub process will finish and be
                  written, then the job will pause. Resume with POST
                  /api/v1/tam/build/8a8e8a97-8192-48ff-849a-d8a96e949732/resume.
        '404':
          description: Job not found for this API key.
        '409':
          description: >-
            Job already finished (completed / failed / cancelled); cannot
            cancel.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    TamBuildPauseResponse:
      type: object
      title: TamBuildPauseResponse
      description: Returned when a pause is requested.
      required:
        - job_id
        - status
        - message
      properties:
        job_id:
          type: string
          title: Job Id
        status:
          type: string
          default: pausing
          title: Status
          description: >-
            `pausing` (will pause at the next band boundary) or already
            `paused`.
        message:
          type: string
          title: Message
    HTTPValidationError:
      type: object
      properties:
        detail:
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
    ValidationError:
      type: object
      required:
        - loc
        - msg
        - type
      properties:
        loc:
          type: array
          items:
            anyOf:
              - type: string
              - type: integer
        msg:
          type: string
        type:
          type: string

````