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

# List the caller's allowed platforms (read-only entitlement)



## OpenAPI

````yaml /api-reference/openapi.json get /settings/platforms
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
paths:
  /settings/platforms:
    get:
      tags:
        - Account
      summary: List the caller's allowed platforms (read-only entitlement)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  availablePlatforms:
                    type: array
                    items:
                      type: string
                      enum:
                        - chatgpt
                        - chatgpt_app
                        - claude
                        - gemini
                        - gemini_app
                        - grok_app
                        - grok_api
                        - perplexity
                        - perplexity_app
                        - google_app
                        - deepseek
                      description: >-
                        LLM platform identifier. Newer scraper-backed ids end in
                        `_app`; `chatgpt`, `perplexity`, and `gemini` are legacy
                        and not returned by current runs.
                  availableOptions:
                    type: array
                    items:
                      type: object
                  platformAvailability:
                    $ref: '#/components/schemas/PlatformAvailability'
                required:
                  - availablePlatforms
        '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:
    PlatformAvailability:
      type: object
      description: >-
        Runtime availability keyed by platform; distinct from entitlement and
        saved selections.
      additionalProperties:
        type: object
        properties:
          platform:
            type: string
            enum:
              - chatgpt
              - chatgpt_app
              - claude
              - gemini
              - gemini_app
              - grok_app
              - grok_api
              - perplexity
              - perplexity_app
              - google_app
              - deepseek
            description: >-
              LLM platform identifier. Newer scraper-backed ids end in `_app`;
              `chatgpt`, `perplexity`, and `gemini` are legacy and not returned
              by current runs.
          status:
            type: string
            enum:
              - available
              - api_fallback
              - unavailable
          primaryDisabled:
            type: boolean
          reason:
            type: string
          route:
            $ref: '#/components/schemas/ExecutionRoute'
        required:
          - platform
          - status
          - primaryDisabled
          - route
    Error:
      type: object
      properties:
        error:
          type: string
        code:
          type: string
          description: Stable machine code for programmatic handling, when applicable.
      required:
        - error
    ExecutionRoute:
      type:
        - object
        - 'null'
      description: >-
        Actual execution route. Null means historical primary; never infer
        today's fallback for old rows.
      properties:
        version:
          type: integer
          const: 1
        source:
          type: string
          enum:
            - primary
            - api_fallback
        provider:
          type: string
        transport:
          type: string
          enum:
            - web
            - api
            - agent_api
        model:
          type: string
        responseId:
          type: string
        reason:
          type: string
      required:
        - version
        - source
        - provider
        - transport
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Clerk API key. Create one from your account settings under API Keys.

````

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