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

# Get deployment build status

> Returns the preview revision, available page routes, publish availability, and build state for the selected head or published source version. Fails with 404 when `target=published` is requested for a never-published website.



## OpenAPI

````yaml /api-reference/openapi.json post /websiteSourceCode/deployment/status
openapi: 3.1.0
info:
  title: Cactal API
  version: 1.0.0
  description: >-
    The Cactal public API. Create, edit, publish, and operate websites
    programmatically. Authenticate every request with an API key sent as
    `Authorization: Bearer <key>`.
servers:
  - url: https://api.cactal.ai/v1
security:
  - apiKey: []
tags:
  - name: Documentation
    description: >-
      Search and read the Cactal product documentation for concepts, guides,
      agent workflows, platform behavior, and API operations.
  - name: Feedback
    description: >-
      Submit free-form product feedback from users and agents to the Cactal
      feedback inbox.
  - name: Websites
    description: >-
      Create and manage websites — the top-level resource that owns source code,
      content, assets, domains, and analytics.
  - name: Website editors
    description: >-
      Grant, list, and revoke website-scoped editor access, and invite
      collaborators to a single website by email.
  - name: API keys
    description: >-
      Create, scope, rotate, and revoke the API keys that authenticate
      programmatic and agent access.
  - name: Source code
    description: >-
      Read and edit the framework source files of a website draft. Mutations
      require an edit lease.
  - name: Publishing
    description: Validate, build, publish, and roll back website versions.
  - name: CMS collections
    description: >-
      Define the content model: collections of structured content owned by a
      website.
  - name: CMS fields
    description: Manage the typed fields that make up a collection schema.
  - name: CMS items
    description: >-
      Create, query, publish, and organize the content entries inside a
      collection.
  - name: Domains
    description: >-
      Manage platform subdomains and custom domains, including DNS verification
      and the primary domain.
  - name: Assets
    description: Upload and manage website files and images served from the Cactal CDN.
  - name: Media generation
    description: >-
      Generate reference-guided website images that are stored as ordinary
      Cactal CDN assets.
  - name: Project Context
    description: >-
      Upload private durable reference material that the website agent can
      search, read, and inspect.
  - name: Analytics
    description: >-
      Read first-party traffic analytics for a website and export datasets as
      CSV.
  - name: Organizations
    description: Manage organizations, members, and organization-wide invitations.
  - name: Audit log
    description: >-
      Read the immutable record of actions performed in an organization by users
      and API keys.
  - name: Billing
    description: >-
      Read billing state and manage plans, site capacity, and prepaid usage
      balance. Every billing operation requires the organization owner role,
      which API keys cannot hold — today these operations are performed from the
      dashboard, return 403 for API-key callers, and are hidden from MCP tool
      lists.
paths:
  /websiteSourceCode/deployment/status:
    post:
      tags:
        - Publishing
      summary: Get deployment build status
      description: >-
        Returns the preview revision, available page routes, publish
        availability, and build state for the selected head or published source
        version. Fails with 404 when `target=published` is requested for a
        never-published website.
      operationId: websiteSourceCode.deployment.status
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                websiteId:
                  type: string
                  minLength: 1
                target:
                  type: string
                  enum:
                    - head
                    - published
              required:
                - websiteId
                - target
      responses:
        '200':
          description: Deployment state for the resolved source version.
          content:
            application/json:
              schema:
                type: object
                properties:
                  websiteId:
                    type: string
                    description: Id of the website.
                  sourceVersion:
                    type: integer
                    description: Source version resolved from `target`.
                  previewRevision:
                    type: string
                    description: >-
                      Opaque value that changes when the preview should be
                      refreshed.
                  hasPages:
                    type: boolean
                    description: >-
                      Whether the resolved source version contains at least one
                      page.
                  pages:
                    type: array
                    items:
                      type: object
                      properties:
                        pageId:
                          type: string
                        route:
                          type: string
                      required:
                        - pageId
                        - route
                      additionalProperties: false
                    description: >-
                      Statically extractable page routes in the resolved source
                      version.
                  canPublish:
                    type: boolean
                    description: >-
                      Whether this preview is ready and has not already been
                      published.
                  deployment:
                    anyOf:
                      - type: object
                        properties:
                          id:
                            type: string
                            description: Unique id of the deployment.
                          status:
                            type: string
                            enum:
                              - building
                              - ready
                              - failed
                            description: Build state of the deployment.
                          failureMessage:
                            description: >-
                              Human-readable build failure summary. `null`
                              unless `status` is `failed`.
                            anyOf:
                              - type: string
                              - type: 'null'
                          failureKind:
                            description: >-
                              Failure category. `null` unless `status` is
                              `failed`.
                            anyOf:
                              - type: string
                                enum:
                                  - transient
                                  - permanent
                                  - unknown
                              - type: 'null'
                        required:
                          - id
                          - status
                        additionalProperties: false
                      - type: 'null'
                    description: >-
                      The deployment for the resolved source version, or `null`
                      when none has been built.
                required:
                  - websiteId
                  - sourceVersion
                  - previewRevision
                  - hasPages
                  - pages
                  - canPublish
                  - deployment
                additionalProperties: false
        '400':
          description: >-
            Validation failed. The response `message` names the first invalid
            field.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '401':
          description: Missing, invalid, expired, or revoked API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '403':
          description: The authenticated principal lacks the required capability.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '404':
          description: >-
            The resource does not exist or is outside the principal’s access
            scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '429':
          description: >-
            Rate limit exceeded. Retry after the number of seconds in the
            `Retry-After` header.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
components:
  schemas:
    ServiceError:
      type: object
      required:
        - kind
        - message
      description: >-
        Canonical error body returned by every non-2xx response. Extra fields
        carry error-specific details.
      properties:
        kind:
          type: string
          enum:
            - validation
            - unauthorized
            - forbidden
            - not_found
            - conflict
            - rate_limited
            - internal
          description: Stable, machine-readable error category.
        message:
          type: string
          description: Human-readable explanation of the failure.
        suggestion:
          type: string
          description: >-
            What to do next when the failure has a known fix; may name the exact
            operation to call.
        validValues:
          type: array
          items:
            type: string
          description: The acceptable values for the failing field, when the set is closed.
      additionalProperties: true
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        Cactal API key. Create one in the dashboard or via `POST /apiKeys`. The
        plaintext key is shown once at creation.

````