Skip to content
Hayonix

API reference · Evaluations

List the models this project can use as a judge or to generate candidates

GET/v1/evaluations/models
API keyevaluation:readProjectPaginated
TypeScript
client.evaluations.listModels()
Python
client.evaluations.list_models()
CLI
hayonix evaluations models

Chat models the project can call that have batch prices (every evaluation call is charged at batch prices), the project’s fine-tuned models, and its dedicated endpoints’ models (paid by replica time).

Project API key (Authorization: Bearer sk_…), or a console session. Requires the evaluation: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/evaluations/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 EvaluationModelList — Usable models

  • The items of this page.

    Show 8 fields of data
    • idstringrequired

      Unique ID (`mdl_…`)

      ID with prefix mdl_

    • objectstringrequired

      Always `evaluation_model`: the type of this object

      One ofevaluation_model

    • modelstringrequired

      The API name to use as `judge.model` or a candidate `model`

    • display_namestringrequired

      Name to show people

    • sourcestringrequired

      A public catalog model, a fine-tuned model, a dedicated endpoint, or another project model

      One ofcatalogfine_tuneddedicated_endpointproject

    • billingstringrequired

      `per_token`: each call is charged per token at batch prices; `replica_time`: a dedicated endpoint, paid by its replica time instead

      One ofper_tokenreplica_time

    • priceobject | nullrequired

      Batch price, nano-USD per 1M tokens (null: paid by replica time)

      Show 2 fields of price
      • inputstring | nullrequired

        nano-USD per 1M prompt tokens; null when the model has no input price

      • outputstring | nullrequired

        nano-USD per 1M generated tokens; null when the model has no output price

    • servingbooleanrequired

      Whether a replica is ready to serve the model right now; calls to a model nobody serves wait, then fail

  • next_cursorstring | nullrequired

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

Example response
Example response
{
  "data": [
    {
      "id": "mdl_01jc5zq4m8k3v6x9t2w7r0b1e4",
      "object": "evaluation_model",
      "model": "string",
      "display_name": "string",
      "source": "catalog",
      "billing": "per_token",
      "price": {
        "input": "string",
        "output": "string"
      },
      "serving": true
    }
  ],
  "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.