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

# Listar endpoints

> Listar os endpoints do gateway baseados em recursos, com caminhos públicos e cobertura de modelos e provedores.

* `endpoints`: os IDs canônicos dos endpoints expostos atualmente pela API
* `data`: registros de endpoints com `public_path`, `collection`, `model_count` e `provider_count`
* `sample_models`: até 10 IDs recentes de modelos visíveis no catálogo público

Use [Listar recursos dos endpoints do modelo](./model-endpoints.mdx) quando precisar de detalhes de um modelo por provedor e parâmetro.


## OpenAPI

````yaml pt-BR/openapi/v1/openapi.localized.yaml GET /endpoints
openapi: 3.0.3
info:
  title: Phaseo Gateway API
  description: >-
    Uma API de gateway para acessar diversos modelos de IA por meio de endpoints
    compatíveis com OpenAI.
  version: 1.0.0
  contact:
    name: Phaseo
    url: https://phaseo.app
    email: danielbutler500@gmail.com
servers:
  - url: https://api.phaseo.app/v1
    description: Roteamento global
security:
  - BearerAuth: []
tags:
  - name: Gateway
    description: Core Phaseo Gateway operations.
paths:
  /endpoints:
    get:
      tags:
        - Gateway
      summary: Listar endpoints
      description: >-
        Lista os IDs de endpoints do gateway baseados em capacidades, com
        caminhos públicos, coleções de modalidades, contagens de modelos e
        provedores e modelos de exemplo.
      operationId: listEndpoints
      responses:
        '200':
          description: Metadados dos endpoints
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointCatalogueResponse'
components:
  schemas:
    EndpointCatalogueResponse:
      type: object
      required:
        - ok
        - endpoints
        - data
        - sample_models
      properties:
        ok:
          type: boolean
          enum:
            - true
        endpoints:
          type: array
          items:
            type: string
        data:
          type: array
          items:
            $ref: '#/components/schemas/EndpointCatalogueEntry'
        sample_models:
          type: array
          items:
            $ref: '#/components/schemas/ModelId'
      additionalProperties: false
    EndpointCatalogueEntry:
      type: object
      required:
        - id
        - capability_id
        - public_path
        - collection
        - model_count
        - provider_count
      properties:
        id:
          type: string
        capability_id:
          type: string
        public_path:
          type: string
        collection:
          type: string
        model_count:
          type: integer
          minimum: 0
        provider_count:
          type: integer
          minimum: 0
      additionalProperties: false
    ModelId:
      type: string
      description: >-
        Identificador do modelo. É uma string de execução, então novos modelos
        podem ser usados sem esperar por uma atualização do SDK.
      example: ai21/jamba-1.5-large
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Autenticação com token Bearer

````

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