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

# GET /portal/api/models



## OpenAPI

````yaml /generated/openapi.json get /portal/api/models
openapi: 3.1.0
info:
  description: >-
    Forwarding, management, portal and OAuth APIs generated from Rust types.
    Input and output schemas preserve their respective Serde contracts.
    Streaming events and WebSocket messages are documented alongside HTTP
    payloads.
  title: GPROXY HTTP API
  version: 4.2.1
servers: []
security:
  - bearer: []
  - anthropicKey: []
  - googleKey: []
  - queryKey: []
paths:
  /portal/api/models:
    get:
      tags:
        - Portal
      summary: GET /portal/api/models
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Output_PortalModelDto'
                type: array
          description: Success
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Output_Envelope'
          description: Gateway error
      security:
        - consoleSession: []
        - bearer: []
        - anthropicKey: []
        - googleKey: []
components:
  schemas:
    Output_PortalModelDto:
      description: >-
        One addressable model name, and whether this caller may call it.


        `providerCount` and `channelIds` describe the providers that back the
        name

        on this instance, not the ones this caller may reach — a count and a

        channel id are instance configuration, and knowing that `codex/gpt-5` is

        served by two providers tells a user nothing about another tenant.

        `permitted` is the caller's own answer.
      properties:
        channelIds:
          description: The channels behind the name, sorted and deduplicated.
          items:
            type: string
          type: array
        name:
          description: Either an exposed model name or a `providerName/model` form.
          type: string
        permitted:
          description: >-
            Whether at least one of those providers is one the caller's
            permission

            rules allow for this name.
          type: boolean
        providerCount:
          format: uint64
          minimum: 0
          type: integer
      required:
        - name
        - providerCount
        - channelIds
        - permitted
      type: object
    Output_Envelope:
      properties:
        error:
          $ref: '#/components/schemas/Output_EnvelopeBody'
      required:
        - error
      type: object
    Output_EnvelopeBody:
      properties:
        code:
          type: string
        message:
          type: string
      required:
        - code
        - message
      type: object
  securitySchemes:
    bearer:
      scheme: bearer
      type: http
    anthropicKey:
      in: header
      name: x-api-key
      type: apiKey
    googleKey:
      in: header
      name: x-goog-api-key
      type: apiKey
    queryKey:
      in: query
      name: key
      type: apiKey
    consoleSession:
      in: cookie
      name: gproxy_session
      type: apiKey

````

## Related topics

- [GET /portal/api/requests](https://gproxy.leenhawk.com/api-reference/portal/get-portalapirequests.md)
- [GET /portal/api/quota](https://gproxy.leenhawk.com/api-reference/portal/get-portalapiquota.md)
- [GET /portal/api/usage](https://gproxy.leenhawk.com/api-reference/portal/get-portalapiusage.md)
- [GET /portal/api/context](https://gproxy.leenhawk.com/api-reference/portal/get-portalapicontext.md)
- [GET /portal/api/keys](https://gproxy.leenhawk.com/api-reference/portal/get-portalapikeys.md)


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