Skip to content
Hayonix

API reference · Dedicated endpoints

Public catalog models a dedicated endpoint can serve, with the engine used on CPU and on GPU hardware

GET/v1/endpoint-models
API keydedicated_endpoint:readProjectPaginated
TypeScript
client.dedicatedEndpoints.listDeployableModels()
Python
client.dedicated_endpoints.list_deployable_models()
CLI
hayonix endpoints models

Available public chat, completion, embedding and rerank models whose weights can be deployed. Pass a listed model as a deployment's model; to serve other weights, use a Hugging Face source instead.

Project API key (Authorization: Bearer sk_…), or a console session. Requires the dedicated_endpoint:read permission (a key's scope, or a role that includes it).

Examples

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

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

Request

Headers
HeaderRequiredDescription
AuthorizationyesBearer and your API key. The key implies its project.
X-Project-Idsession onlyThe project to act in, for console sessions. Requests with an API key leave it out.

Query parameters

  • limitinteger

    1–200, default 50

    1–200

  • cursorstring

    `next_cursor` of the previous page

    up to 200 characters

Response

200 a page of results — Deployable models

  • The items of this page.

    Show 8 fields of data
    • objectstringrequired

      Always `deployable_model`: the type of this object

      One ofdeployable_model

    • modelstringrequired

      Model ID (`publisher/name`)

    • display_namestringrequired

      Name to show people

    • typestringrequired

      What the model does

      One ofchatcompletionembeddingrerank

    • publisherstring | nullrequired

      Who published the model; null when not recorded

    • context_lengthinteger | nullrequired

      The model's context length in tokens; null when not known

    • weightsobjectrequired

      The weights a deployment of this model serves

      Show 2 fields of weights
      • repositorystringrequired

        The Hugging Face repository the weights come from

      • filestring | nullrequired

        The weights file or quantisation tag used; null when the whole repository is used

    • enginesobjectrequired

      The engine chosen by default on each kind of hardware

      Show 2 fields of engines
      • cpustring | nullrequired

        The engine used on CPU hardware (null: GPU only)

        One ofllama_cppteivllm

      • gpustringrequired

        The engine used on GPU hardware

        One ofllama_cppteivllm

  • next_cursorstring | nullrequired

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

Example response
Example response
{
  "data": [
    {
      "object": "deployable_model",
      "model": "qwen/qwen2.5-0.5b-instruct",
      "display_name": "string",
      "type": "chat",
      "publisher": "string",
      "context_length": 1,
      "weights": {
        "repository": "string",
        "file": "string"
      },
      "engines": {
        "cpu": "llama_cpp",
        "gpu": "llama_cpp"
      }
    }
  ],
  "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.
401authentication_errorThe key or session is missing, revoked or expired.
403permission_errorThe credential lacks the permission this needs, or the organization is suspended.
429rate_limit_error rate_limitedToo many requests; retry after retry-after seconds.