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

# Get an app

> Return one app, including its build status and editor URL.

Returns one app. `buildStatus` is one of `none`, `building`, `success`, or `failure` — poll it after a
[commit](/build-api/sessions/commit) before you [publish](/build-api/deployments/publish-deployment).
`published` flips once a snapshot is published.


## OpenAPI

````yaml build-api/openapi.json GET /apps/{appId}
openapi: 3.0.1
info:
  title: Zite Build API
  description: >-
    Create, build, and deploy Zite apps programmatically — the REST equivalent
    of the Zite MCP build tools. Use it from a script, a CI pipeline, or your
    own agent.


    ## Authentication


    All requests require a Bearer API key from your Developer settings:

    ```

    Authorization: Bearer YOUR_API_KEY

    ```

    The key acts as you — it can only see and change workspaces you have access
    to, and every change is attributed to you.


    ## Base URL


    https://api.zite.com/v1


    ## Errors


    Errors return `{ "statusCode": 404, "error": "Not Found", "message":
    "Workspace not found" }`. Notable statuses: `401` (bad or missing key),
    `402` (the build tools aren't in your plan), `404`, `409` (a commit push
    conflict — pull, rebase, and commit again), and `400` for validation
    failures and publishing before a build is green.
  version: 1.0.0
servers:
  - url: https://api.zite.com/v1
    description: Zite Build API
security:
  - bearerAuth: []
tags:
  - name: Workspaces
    description: Create workspaces and inspect the apps in them.
  - name: Build sessions
    description: >-
      Open an isolated checkout of a workspace, create apps, edit files, check,
      and commit.
  - name: Deployments
    description: Publish built apps, manage versions, roll back, and read runtime logs.
paths:
  /apps/{appId}:
    get:
      tags:
        - Workspaces
      summary: Get an app
      description: >-
        Returns one app. `buildStatus` is one of `building`, `success`, or
        `failed` — poll it after a commit before you publish. `liveUrl` is set
        once an external app is published.
      operationId: getApp
      parameters:
        - $ref: '#/components/parameters/AppId'
      responses:
        '200':
          description: The app
          content:
            application/json:
              schema:
                type: object
                properties:
                  app:
                    $ref: '#/components/schemas/App'
              example:
                id: app_a1b2c3
                name: Agent console
                dir: apps/agent-console
                accessMode: internal
                buildStatus: success
                liveUrl: null
                editorUrl: https://app.zite.com/editor/zite/app_a1b2c3
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    AppId:
      name: appId
      in: path
      required: true
      description: The app ID.
      schema:
        type: string
      example: app_a1b2c3
  schemas:
    App:
      type: object
      properties:
        id:
          type: string
          example: app_a1b2c3
        name:
          type: string
          example: Agent console
        dir:
          type: string
          nullable: true
          example: apps/agent-console
        workspaceId:
          type: string
          nullable: true
          example: wsp8bce4d1edc51710
        buildStatus:
          $ref: '#/components/schemas/BuildStatus'
        buildError:
          type: string
          nullable: true
          description: Compiler or build output. Only set when `buildStatus` is `failure`.
        accessMode:
          $ref: '#/components/schemas/AccessMode'
        published:
          type: boolean
          description: Whether a snapshot is currently published.
        updatedAt:
          type: string
          format: date-time
    BuildStatus:
      type: string
      enum:
        - none
        - building
        - success
        - failure
      description: >-
        The state of the app's most recent build. `none` means the app has never
        been built.
    AccessMode:
      type: string
      enum:
        - internal
        - external
      default: internal
      description: >-
        `internal` apps are available to your organization; `external` apps
        deploy to a public subdomain.
    Error:
      type: object
      properties:
        statusCode:
          type: integer
          example: 404
        error:
          type: string
          example: Not Found
        message:
          type: string
          example: Workspace not found
  responses:
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: UNAUTHORIZED
              message: Missing or invalid API key.
    NotFound:
      description: The resource does not exist or your key cannot access it.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: NOT_FOUND
              message: Workspace not found.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Enter your Zite API key. Format: Bearer <api_key>'

````