Skip to main content
POST
CSharp (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.

Headers

X-On-Behalf-Of
string

Optional external end-user identifier forwarded by the API gateway.

Path Parameters

suite_id
string
required

Body

application/json
model
string
required

The leaderboard row to analyse: a model id exactly as it appears on the board.

Required string length: 1 - 255
suite_version
integer

Suite version whose runs are analysed. Defaults to the suite's active version.

Required range: 1 <= x <= 9007199254740991
metric_id
string

Headline metric that defines a failure (e.g. wer, scribe_v2_wer, score). Defaults to the board's default metric.

Required string length: 1 - 128
failure_threshold
number

Overrides the failure threshold: a sample fails when a lower-is-better metric is at or above it, or a higher-is-better metric is below it. Defaults: 0.1 and 0.5.

sample_size
integer

How many failures to analyse. Default 100.

Required range: 10 <= x <= 200
force
boolean

Start a new analysis even when a finished one exists for the same samples, metric and prompt version.

analyzer_model
string

Analyzer model to use, one of GET /evals/error-analysis/analyzers. Defaults to the cluster's default analyzer.

Required string length: 1 - 128

Response

200 - application/json

OK

id
string
required
object
any
required
suite_id
string
required
suite_version
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
model
string
required
metric_id
string
required
kind
enum<string>
required
Available options:
tts,
asr,
text
status
enum<string>
required
Available options:
queued,
running,
done,
failed
analyzer_model
string
required
prompt_version
string
required
cache_key
string
required
selection
object
required

Counts behind the sample: failures in total, per task and per tier, the threshold, the board context.

samples_analysed
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
usage
object | null
required
error
string | null
required
created_by
string | null
required

The user id that started it; null for a reader in a shared org, which does not see the owner org's users.

created_at
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
started_at
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
finished_at
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
sample_ids
object[]
required
tags
object[]
required
report
object | null
required
report_markdown
string | null
required

The report rendered as Markdown; null until the analysis is done.