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

# Poll the status of a run

> Pass `runId` for a specific run, or only `projectId` to fetch the project's most recent run. Returns `status: "none"` when no run exists yet.



## OpenAPI

````yaml /api-reference/openapi.json get /prompts/status
openapi: 3.1.0
info:
  title: OpenLens API
  version: 1.4.0
  description: >-
    Public REST API for OpenLens. Onboard clients, run scans across the major AI
    platforms, read visibility metrics, and download client-ready reports. Beta
    — endpoints may evolve before GA.
  contact:
    name: OpenLens support
    email: contact@aibread.com
servers:
  - url: https://openlens.com/api
security:
  - bearerAuth: []
tags:
  - name: Onboarding
  - name: Runs
  - name: Metrics
  - name: Citations
  - name: Deliverables
  - name: Resources
  - name: Account
  - name: Workstreams
paths:
  /prompts/status:
    get:
      tags:
        - Runs
      summary: Poll the status of a run
      description: >-
        Pass `runId` for a specific run, or only `projectId` to fetch the
        project's most recent run. Returns `status: "none"` when no run exists
        yet.
      parameters:
        - name: projectId
          in: query
          required: true
          schema:
            type: string
            format: uuid
          description: Project id. Required on all data endpoints.
        - name: runId
          in: query
          required: false
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  runId:
                    type: string
                    format: uuid
                  status:
                    type: string
                    enum:
                      - running
                      - completed
                      - failed
                      - interrupted
                      - cancelled
                      - none
                    description: >-
                      `cancelled` is reported by /prompts/status when a `failed`
                      run had `cancelRequested = true`. `none` only appears when
                      no run exists for the project.
                  totalTasks:
                    type: integer
                  completedTasks:
                    type: integer
                  failedTasks:
                    type: integer
                  pendingTasks:
                    type: integer
                  cancelledTasks:
                    type: integer
                  incompleteTasks:
                    type: integer
                  scraperAttempted:
                    type: boolean
                  scraperSucceeded:
                    type: boolean
                  startedAt:
                    type:
                      - string
                      - 'null'
                    format: date-time
                  completedAt:
                    type:
                      - string
                      - 'null'
                    format: date-time
        '400':
          description: Missing or invalid request parameter.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing, malformed, or revoked API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          description: >-
            Monthly included API calls for your tier are used up (code
            `USAGE_LIMIT`). Body includes a `limit` object — `{ limitHit,
            currentTier, targetTier, feature, cap, used, resetAt }` — describing
            the cap and the upgrade that lifts it.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Resource not found or not owned by your account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: >-
            Rate limit, project cap, or daily quota hit. Body includes a `code`
            field.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error. Retry; if persistent, contact support.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
        code:
          type: string
          description: Stable machine code for programmatic handling, when applicable.
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Clerk API key. Create one from your account settings under API Keys.

````