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

# Get the API contract

> Read field definitions, source limits, availability states, and agent instructions.

Read this endpoint before querying model records. It returns the static contract without loading model data.

The [field glossary](/api-reference/fields) uses these same definitions. Check each model response for its own generation time, data window, and freshness.


## OpenAPI

````yaml openapi.json GET /api/v1/about
openapi: 3.1.0
info:
  title: Model Demand Agent API
  version: model-demand.agent-api.v1
  description: >-
    OpenRouter demand and exact official Hugging Face evidence are separate
    sources. This read-only API gives public model demand and model facts. It
    also gives missing-size reasons, availability states, and source limits.
servers:
  - url: https://model-demand-analytics.vercel.app
security: []
paths:
  /api/v1/about:
    get:
      summary: Get the API contract
      description: >-
        Return static field definitions, source limits, availability states, and
        agent instructions.
      operationId: getAgentApiAbout
      responses:
        '200':
          description: The static API contract.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentAboutDocument'
components:
  schemas:
    AgentAboutDocument:
      type: object
      additionalProperties: false
      required:
        - schema_version
        - api_schema_version
        - documentation_version
        - routes
        - query_parameters
        - field_definitions
        - availability_states
        - sources
        - supply
        - links
        - agent_instructions
      properties:
        schema_version:
          type: string
          const: model-demand.agent-about.v1
        api_schema_version:
          type: string
          const: model-demand.agent-api.v1
        documentation_version:
          type: string
          minLength: 1
        routes:
          type: array
          items:
            $ref: '#/components/schemas/AboutRoute'
        query_parameters:
          type: array
          items:
            $ref: '#/components/schemas/AboutQueryParameter'
        field_definitions:
          type: array
          items:
            $ref: '#/components/schemas/AboutFieldDefinition'
        availability_states:
          type: array
          items:
            $ref: '#/components/schemas/AboutAvailabilityState'
        sources:
          type: array
          items:
            $ref: '#/components/schemas/AboutSource'
        supply:
          $ref: '#/components/schemas/AboutSupply'
        links:
          $ref: '#/components/schemas/AboutLinks'
        agent_instructions:
          type: array
          minItems: 1
          items:
            type: string
            minLength: 1
    AboutRoute:
      type: object
      additionalProperties: false
      required:
        - method
        - path
        - description
      properties:
        method:
          type: string
          const: GET
        path:
          type: string
          enum:
            - /api/v1/about
            - /api/v1/models
        description:
          type: string
          minLength: 1
    AboutQueryParameter:
      type: object
      additionalProperties: false
      required:
        - name
        - type
        - required
        - default
        - allowed_values
        - description
      properties:
        name:
          type: string
          enum:
            - model_id
            - sort
            - order
            - limit
            - offset
        type:
          type: string
          enum:
            - string
            - integer
        required:
          type: boolean
        default:
          type:
            - string
            - integer
            - 'null'
        allowed_values:
          oneOf:
            - type: array
              items:
                type: string
            - type: 'null'
        description:
          type: string
          minLength: 1
    AboutFieldDefinition:
      type: object
      additionalProperties: false
      required:
        - path
        - type
        - unit
        - nullable
        - description
      properties:
        path:
          type: string
          minLength: 1
        type:
          type: string
          enum:
            - string
            - integer
            - boolean
            - object
            - array
        unit:
          type:
            - string
            - 'null'
        nullable:
          type: boolean
        description:
          type: string
          minLength: 1
    AboutAvailabilityState:
      type: object
      additionalProperties: false
      required:
        - state
        - meaning
      properties:
        state:
          type: string
          enum:
            - available
            - unavailable
            - not_publicly_cleared
            - not_available
            - not_found_under_policy
        meaning:
          type: string
          minLength: 1
    AboutSource:
      type: object
      additionalProperties: false
      required:
        - name
        - url
        - terms_url
        - license
        - limit_note
      properties:
        name:
          type: string
          minLength: 1
        url:
          type: string
          format: uri
        terms_url:
          type: string
          format: uri
        license:
          type:
            - string
            - 'null'
        limit_note:
          type: string
          minLength: 1
    AboutSupply:
      type: object
      additionalProperties: false
      required:
        - launch_state
        - states
        - description
      properties:
        launch_state:
          type: string
          enum:
            - not_collected
            - enabled
        states:
          type: array
          minItems: 5
          maxItems: 5
          items:
            type: string
            enum:
              - not_collected
              - temporarily_unavailable
              - current_route_not_found
              - current_route_ambiguous
              - available
        description:
          type: string
          minLength: 1
    AboutLinks:
      type: object
      additionalProperties: false
      required:
        - documentation
        - openapi
        - full_export
      properties:
        documentation:
          type: string
          format: uri
        openapi:
          type: string
          format: uri
        full_export:
          type: string
          format: uri

````