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

# Read an app

> The app's address, place in the hierarchy, status and live deployment, by slug or id, with the caller's level.



## OpenAPI

````yaml https://dojo.frogbot.ai/api/openapi.json get /api/apps/{app}/cli
openapi: 3.1.0
info:
  title: Dojo API
  version: '1'
  description: >-
    Everything Dojo's pages do, for scripts and agents. Sign in with an API key
    as `Authorization: Bearer fb_…`. Paying and accepting the terms happen at a
    link a route answers, for a person to open.
servers:
  - url: https://dojo.frogbot.ai
security:
  - apiKey: []
tags:
  - name: Sign-in
  - name: Workspaces
  - name: Projects
  - name: Apps
  - name: Templates
  - name: Sharing
  - name: Deployments
  - name: Environment variables
  - name: Domains
  - name: Data
  - name: Billing
  - name: API keys
paths:
  /api/apps/{app}/cli:
    get:
      tags:
        - Apps
      summary: Read an app
      description: >-
        The app's address, place in the hierarchy, status and live deployment,
        by slug or id, with the caller's level.
      operationId: get/api/apps/:app/cli
      parameters:
        - name: app
          in: path
          required: true
          description: The app's slug, such as `deals`, or its id.
          schema:
            type: string
        - name: secret
          in: query
          required: false
          description: >-
            `1` adds the app's `secret` to an owner's reply; an editor's has
            none, and an app staff removed answers 403.
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: A document id.
                  slug:
                    type: string
                  name:
                    type: string
                  workspace:
                    type: string
                    description: A document id.
                  project:
                    anyOf:
                      - type: string
                        description: A document id.
                      - type: 'null'
                  url:
                    type: string
                    description: '`https://<slug>.frogbot.app`.'
                  domain:
                    anyOf:
                      - type: string
                      - type: 'null'
                    description: >-
                      The custom domain saved on the app; `GET
                      /api/apps/{app}/domain` says whether it is live.
                  status:
                    type: string
                    enum:
                      - removed
                      - paused
                      - live
                      - deploying
                      - failed
                      - not_deployed
                  deployment:
                    anyOf:
                      - type: string
                        description: A document id.
                      - type: 'null'
                    description: The live deployment.
                  started:
                    type: boolean
                  level:
                    type: string
                    enum:
                      - editor
                      - owner
                  secret:
                    type: string
                    description: >-
                      The app's `FROGBOT_SECRET`, only for an owner who asks
                      with `?secret=1`, so a pulled copy keeps its connections
                      and sign-ins (platform-28 D3).
                required:
                  - id
                  - slug
                  - name
                  - workspace
                  - project
                  - url
                  - domain
                  - status
                  - deployment
                  - started
                  - level
        '401':
          description: '`unauthorized`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: '`forbidden`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: '`not_found`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
components:
  schemas:
    Errors:
      type: object
      required:
        - errors
      properties:
        errors:
          type: array
          items:
            type: object
            required:
              - message
            properties:
              message:
                type: string
              data:
                type: object
                properties:
                  code:
                    type: string
                  url:
                    type: string
                    description: Where a person takes the next step, such as paying.
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        An API key from `frogbot deploy`'s sign-in, `/api/cli/device/token`, or
        the API keys page.

````

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