> ## 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.

# Download a client-ready PDF visibility report

> Renders a multi-page PDF for the chosen run. `runId` is required — the caller picks the run from `/reports/runs`. Optionally include the full per-prompt detail via `includePrompts=1`.



## OpenAPI

````yaml /api-reference/openapi.json get /reports/visibility
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:
  /reports/visibility:
    get:
      tags:
        - Deliverables
      summary: Download a client-ready PDF visibility report
      description: >-
        Renders a multi-page PDF for the chosen run. `runId` is required — the
        caller picks the run from `/reports/runs`. Optionally include the full
        per-prompt detail via `includePrompts=1`.
      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: true
          schema:
            type: string
            format: uuid
        - name: includePrompts
          in: query
          required: false
          schema:
            type: string
            enum:
              - '1'
              - '0'
              - 'true'
              - 'false'
              - 'yes'
              - 'no'
        - name: promptAttributes
          in: query
          required: false
          schema:
            type: string
          description: >-
            Comma-separated list of attribute filters. Accepts both built-in
            attributes (e.g. `pricing`, `comparisons`) and project-specific
            custom attributes.
      responses:
        '200':
          description: PDF report.
          content:
            application/pdf:
              schema:
                type: string
                format: binary
        '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.

````