Skip to content
Hayonix

API reference · Models

Get a catalog model (private models only for their own project)

GET/v1/catalog/models/{model_id}
No authentication
TypeScript
client.models.get()
Python
client.models.get()
CLI
hayonix models show

Works without credentials for public models. A private model is returned only to callers with credentials for the project that owns it; to anyone else it is 404, as if it did not exist.

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/mdl_01jc5zq4m8k3v6x9t2w7r0b1e4" \
  -H "Authorization: Bearer $API_KEY"

Request

Path parameters

  • model_idstringrequired

    ID of the model

    ID with prefix mdl_

Response

200 CatalogModel — The model

  • 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)

Example response
Example response
{
  "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": "audio_input_ms",
        "unit_price": "1500000000",
        "unit_quantity": "60000",
        "display_unit": "per minute of audio"
      }
    ]
  },
  "serving": true,
  "created_at": "2026-01-01T00:00:00.000Z"
}

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.
404not_found_errorNo such resource in this project (an ID from another project is answered the same way).
429rate_limit_error rate_limitedToo many requests; retry after retry-after seconds.