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

# Models

> Lists all models available through the proxy, including pricing information per model.

Useful for frontend model selectors or pricing calculators.




## OpenAPI

````yaml GET /models
openapi: 3.1.0
info:
  title: Paywalls.ai API
  description: >
    The Paywalls.ai API enables developers to integrate monetization and access
    control for OpenAI-compatible LLMs.


    This proxy service supports multiple pricing strategies—including
    per-request, token-based, and subscription models—while maintaining full
    compatibility with the OpenAI API format.


    Requests are automatically checked for user authorization and balance. If
    the user is not connected to the paywall, or lacks sufficient balance, the
    API will return actionable links for onboarding or top-up.


    Use this API to monetize your AI-powered apps and services with minimal
    effort.


    Visit [paywalls.ai](https://docs.paywalls.ai) for full documentation and
    setup guides.
  version: 1.0.0
servers:
  - url: https://api.paywalls.ai/v1
    description: Primary production server
security:
  - ApiKeyAuth: []
tags:
  - name: Chat
    description: >
      OpenAI-compatible chat completion endpoint that enforces paywall logic
      before proxying the request to a model provider.


      Automatically checks user connection, balance, and performs charging.
      Supports streaming and non-streaming completions.
  - name: Models
    description: >
      Retrieve metadata and pricing information about the LLM models supported
      by the proxy.


      Includes prompt and completion pricing, per-request costs, and display
      details for UI integration.
  - name: User
    description: >
      Endpoints for managing user sessions, balance, and charging status.


      Includes functionality for connecting to or disconnecting from the
      paywall, checking balance, initiating top-ups, and issuing manual charges.
  - name: Webhooks
    description: >
      Manage webhook subscriptions and inspect delivery activity for your
      paywall integrations.
paths:
  /models:
    get:
      tags:
        - Models
      summary: Retrieve available LLM models
      description: >
        Lists all models available through the proxy, including pricing
        information per model.


        Useful for frontend model selectors or pricing calculators.
      parameters:
        - $ref: '#/components/parameters/XPaywallUser'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    description: A list of available models.
                    items:
                      $ref: '#/components/schemas/Model'
                required:
                  - data
                example:
                  data:
                    - id: gpt-3.5-turbo
                      object: model
                      name: gpt-3.5-turbo
                      display_name: GPT-3.5 Turbo
                      description: A powerful language model for various tasks.
                      pricing:
                        prompt: '0.5'
                        completion: '1'
                        request: '0.01'
components:
  parameters:
    XPaywallUser:
      name: X-Paywall-User
      in: header
      required: false
      schema:
        type: string
      description: >
        Optional user identifier provided by the developer.

        Can be used instead of the `user` property in the request body to
        associate the API call with a specific end user.
  schemas:
    Model:
      type: object
      description: Metadata for a supported LLM model available through the proxy.
      properties:
        id:
          type: string
          description: Unique model identifier (e.g., gpt-3.5-turbo).
        object:
          type: string
          description: Type of the returned object. Typically \"model\".
        name:
          type: string
          description: Short internal name of the model.
        display_name:
          type: string
          description: Human-readable name of the model, suitable for UI use.
        description:
          type: string
          description: Short summary of the model’s capabilities or intended use case.
        pricing:
          $ref: '#/components/schemas/ModelPricing'
    ModelPricing:
      type: object
      description: >
        Cost configuration for a specific model, used to calculate charges for
        each request.
      properties:
        prompt:
          type: string
          description: Cost per 1 million prompt tokens (as a stringified decimal).
        completion:
          type: string
          description: Cost per 1 million completion tokens (as a stringified decimal).
        request:
          type: string
          description: Flat fee per request, in USDC or equivalent.
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer

````