Skip to content
Hayonix

API reference · Models

List catalog models (public ones; with credentials, also the project's private ones)

GET/v1/catalog/models
No authenticationPaginated
TypeScript
client.models.list()
Python
client.models.list()
CLI
hayonix models list

Works without credentials. Each model carries its prices from the price book in force, its context length, capabilities and whether a replica is serving it right now. With an API key, or a session plus X-Project-Id, the list also includes that project's private models (fine-tuned models and dedicated endpoints).

None: this operation is public.

Examples

The samples read API_KEY and API_BASE_URL from the environment (see Setup). Values are examples.

curl -sS "$API_BASE_URL/catalog/models" \
  -H "Authorization: Bearer $API_KEY"

Request

Query parameters

  • limitinteger

    1–200, default 50

    1–200

  • cursorstring

    `next_cursor` of the previous page

    up to 200 characters

  • typestring

    Only models of this type

    One ofchatcompletionembeddingrerankimagespeech_to_texttext_to_speech

Response

200 a page of results — A page of catalog models

  • The items of this page.

    Show 15 fields of data
    • objectstringrequired

      Always `catalog_model`: the type of this object

      One ofcatalog_model

    • idstringrequired

      Unique ID (`mdl_…`)

      ID with prefix mdl_

    • modelstringrequired

      Model ID (`publisher/name`)

    • display_namestringrequired

      Name to show people

    • typestringrequired

      What the model does: `chat` (chat completions), `completion` (text completions), `embedding` (vectors), `rerank` (document reranking), `image` (image generation), `speech_to_text` (transcription), `text_to_speech` (speech synthesis), `adapter` (a fine-tuned adapter served on its base model)

      One ofchatcompletionembeddingrerankimagespeech_to_texttext_to_speechadapter

    • visibilitystringrequired

      `public`: listed for everyone; `private`: visible only to the project that owns it (fine-tuned models and dedicated endpoints)

      One ofpublicprivate

    • publisherstring | nullrequired

      Who published the model; null when not recorded

    • descriptionstring | nullrequired

      Free-text description

    • licensestring | nullrequired

      The model's license; null when not recorded

    • context_lengthinteger | nullrequired

      Maximum number of tokens in one request, prompt and output together; null when it does not apply or is not known

    • capabilitiesobjectrequired

      Features the model supports, keyed by name (for example `streaming: true`); a missing key means the feature is not offered

    • statusstringrequired

      `available`: offered normally; `deprecated`: still listed but no longer recommended and may be removed, so plan a move to another model

      One ofavailabledeprecated

    • pricingModelPricing | any JSON | nullrequired

      Prices from the price book in force; null when the model has no price

      Show 8 fields of pricing
      • currencystringrequired

        Always `usd`

        One ofUSD

      • unitstringrequired

        Unit of the token prices: nano-USD (1 USD = 1_000_000_000) per 1 million tokens

        One ofnano_usd_per_1m_tokens

      • inputstring | nullrequired

        nano-USD per 1M tokens, as a decimal string

        pattern ^-?[0-9]+$

      • cached_inputstring | null

        nano-USD per 1M tokens, as a decimal string

        pattern ^-?[0-9]+$

      • outputstring | null

        nano-USD per 1M tokens, as a decimal string

        pattern ^-?[0-9]+$

      • placeholderbooleanrequired

        True while the prices are development placeholders

      • batchobject | null

        Prices for the batch API (asynchronous, discounted), per 1M tokens; null when the model cannot be used in a batch

        Show 3 fields of batch
        • inputstring | nullrequired

          nano-USD per 1M tokens, as a decimal string

          pattern ^-?[0-9]+$

        • cached_inputstring | null

          nano-USD per 1M tokens, as a decimal string

          pattern ^-?[0-9]+$

        • outputstring | null

          nano-USD per 1M tokens, as a decimal string

          pattern ^-?[0-9]+$

      • unitsarray of object

        Speech-to-text, text-to-speech and image models are priced per unit, not per token: one entry per meter (the token prices are then null)

        Show 4 fields of units
        • meterstringrequired

          What is counted: `audio_input_ms` (milliseconds of input audio), `speech_character` (input characters), `image_small` / `image_medium` / `image_large` (generated images by size tier)

        • unit_pricestringrequired

          nano-USD per `unit_quantity` units

          pattern ^-?[0-9]+$

        • unit_quantitystringrequired

          Decimal string

        • display_unitstring | nullrequired

          Human-readable unit that `unit_price` is quoted in; null when there is none

    • servingbooleanrequired

      Whether a replica is ready to serve the model right now (the same sources the inference gateway routes by); a listed model may have none

    • created_atstring (date-time)required

      When it was created (ISO 8601, UTC)

  • next_cursorstring | nullrequired

    Pass as `cursor` for the next page; null on the last page.

Example response
Example response
{
  "data": [
    {
      "object": "catalog_model",
      "id": "mdl_01jc5zq4m8k3v6x9t2w7r0b1e4",
      "model": "qwen/qwen2.5-0.5b-instruct",
      "display_name": "string",
      "type": "chat",
      "visibility": "public",
      "publisher": "string",
      "description": "string",
      "license": "string",
      "context_length": 1,
      "capabilities": {},
      "status": "available",
      "pricing": {
        "currency": "USD",
        "unit": "nano_usd_per_1m_tokens",
        "input": "100000000",
        "cached_input": "100000000",
        "output": "100000000",
        "placeholder": true,
        "batch": {
          "input": "100000000",
          "cached_input": "100000000",
          "output": "100000000"
        },
        "units": [
          {
            "meter": null,
            "unit_price": null,
            "unit_quantity": null,
            "display_unit": null
          }
        ]
      },
      "serving": true,
      "created_at": "2026-01-01T00:00:00.000Z"
    }
  ],
  "next_cursor": "string"
}

Errors

Errors use the standard envelope. What this operation can answer:

Errors
StatusTypeWhen
400invalid_request_errorA parameter or body field is missing or not allowed; param names it.
429rate_limit_error rate_limitedToo many requests; retry after retry-after seconds.