Skip to main content
POST
Go (SDK)

Authorizations

Authorization
string
header
required

Send Authorization: Bearer , using an MKA1 API key for automation or an OAuth API access token for a signed-in application. Use a dynamic security callback to refresh OAuth access tokens. Browser session-only operations still require their declared cookie.

Body

application/json
name
string
required

The model name callers use. It is claimed in the organization's registry, so it must not already be active.

Required string length: 1 - 255
suite_id
string
required

An eval suite owned by this organization.

Required string length: 1 - 255
metric
string
required

A metric id the suite's active version declares. Its higher_is_better decides which score wins.

Required string length: 1 - 128
candidate_model_ids
string[]
required

Two to 16 active models of one API format. The alias only ever serves one of these. Order breaks ties: the earlier model wins an equal score.

Required array length: 2 - 16 elements
Required string length: 1 - 255
task_id
string | null

A task of the suite to rank on. Null ranks the metric averaged over every task, counting only runs that cover every task of the version.

Required string length: 1 - 255
default_model_id
string | null

A candidate to serve until a first winner exists. Null leaves the alias unresolvable until then.

Required string length: 1 - 255

Response

200 - application/json

OK

object
any
required
name
string
required
suite_id
string
required
suite_version
integer | null
required

The suite version the last recompute ranked. Null before one could be read.

Required range: -9007199254740991 <= x <= 9007199254740991
metric
string
required
higher_is_better
boolean | null
required
task_id
string | null
required
candidate_model_ids
string[]
required
api_format
enum<string>
required
Available options:
responses,
completions,
embeddings,
images,
transcriptions,
tts,
rerank
default_model_id
string | null
required
pinned_model_id
string | null
required
current_model_id
string | null
required

The benchmark winner. Null until one exists.

served_model_id
string | null
required

What a request for the alias is served by: the pin, else the winner, else the default.

served_because
enum<string> | null
required
Available options:
pinned,
benchmark,
default
state
enum<string>
required

ok: serving a ranked winner. waiting_for_results: no complete result to rank yet, so the last winner or the default holds. metric_missing: the suite's active version no longer declares the metric or task. suite_missing: the suite was deleted. The last two hold the last winner until the alias is edited.

Available options:
ok,
waiting_for_results,
metric_missing,
suite_missing
resolvable
boolean
required

Whether a request for the alias resolves right now: it serves a model that is still active in the registry.

standings
object[]
required
evaluated_at
string<date-time> | null
required
created_by
string
required
created_at
string<date-time>
required
updated_by
string
required
updated_at
string<date-time>
required