Skip to content

Checks_GetCheckRun

GET
/v1/accounts/{account}/checks/{check}/runs/{run}
curl --request GET \
--url https://dev-api.qualiastudios.dev/v1/accounts/example/checks/example/runs/example \
--header 'X-API-Key: <X-API-Key>'

Gets one run. NOT_FOUND outside the caller’s workspace, and under another check than the one it ran.

account
required
string

The account id.

check
required
string

The check id.

run
required
string

The run id.

OK

Media type application/json

One run of a check over a dataset, as RunCheck recorded it (QUA-3397). Its id is the operation’s (RunCheckResponse.operation), so its events on the record name it too. A merged dataset is checked one upload at a time, one run each, named under the upload, but for VLM and REACH, which are one run named under the merged dataset.

Served by qds-api.

object
name

Accounts/{account}/checks/{check}/runs/{run}

string
dataset

Accounts/{account}/datasets/{dataset}: the dataset it checked (an upload, for each per-upload run of a merged dataset).

string
operation

Accounts/{account}/operations/{operation}: the same id, as RunCheckResponse.operation and the record’s events name it.

string
state

Where it stands.

string format: enum
Allowed values: STATE_UNSPECIFIED QUEUED RUNNING SUCCEEDED FAILED
failureReason

Why it failed; empty otherwise.

string
selectedCount

Episodes of the selection; 0 when it checked the whole dataset.

integer format: int32
raisedCount

Issues and notes it opened (new ones, and ones a re-run had closed); set once it succeeded.

integer format: int32
resolvedCount

Open issues and notes it no longer found, dismissed as RESOLVED; set once it succeeded.

integer format: int32
creator

Who started it.

object
kind

What kind of actor it is.

string format: enum
Allowed values: KIND_UNSPECIFIED PERSON VALIDATION RULE MODEL OPERATOR SYSTEM
user

The person’s user id when kind is PERSON; empty otherwise.

string
displayName

The person’s display name at the time, for rendering without a lookup.

string
agent

The rule code, or the model id (e.g. “gemini-robotics-er”), when not a person.

string
run

The run a model or rule finding came from, when it has one.

string
apiKey

The API key’s id when a person acted through one; empty for a session. Never the key itself.

string
attribution

Signed identity evidence recorded with the change, kept apart from the principal above. Unset on older records and wherever none was signed.

object
authentication

How the principal authenticated.

string format: enum
Allowed values: AUTHENTICATION_UNSPECIFIED SESSION API_KEY SERVICE
initiator

The user id of a person verified as starting the work: the person of a session, or the person a trusted service’s signed job record names. Empty when nobody was verified.

string
initiatorDisplayName

The initiator’s display name at the time, never their email.

string
credentialCreator

The user id of the key’s creator at the time. Not who used the key.

string
credentialOwner

Who owned the key at the time.

string format: enum
Allowed values: CREDENTIAL_OWNER_UNSPECIFIED PERSON SPACE
credentialOwnerSpace

The owning space’s id (a workspace or the organization) when credential_owner is SPACE.

string
createTime

When RunCheck recorded it.

string format: date-time
updateTime

When it last moved; once it ended, when it ended.

string format: date-time
vlm

The VLM check’s.

object
model

The model that read (or reads) the episodes: the one asked for, or once the run answered, the one it reports. Empty while a run that named none has not answered.

string
pipelineRun

The pipeline run that reads the episodes, a UUID; empty until it started. The gateway serves its status and settled credits.

string
episodeCount

Episodes planned for the model: linked to a published task.

integer format: int32
unlinkedCount

Episodes of the selection left out: no published task.

integer format: int32
unreadCount

Planned episodes the model could not read (no published video, a refused call, an invalid answer); their issues are left as they were.

integer format: int32
passCount

Findings written, by verdict.

integer format: int32
failCount

Failing findings: issues at CONFIDENT confidence or more, else notes.

integer format: int32
uncertainCount

Uncertain findings: notes.

integer format: int32
datasetChecks

Accounts/{account}/datasets/{dataset}/checks/{check}: the catalog checks a RunDatasetChecks run reads, by category then check id; empty for a run of the single VLM check.

Array<string>
reviewHealth

A graph check run’s review health, computed once when its pipeline run ended; set once the run succeeded on a template with the review_health step.

object
available

The rules could read this run. When false, unavailable_code and unavailable_reason say why; the numbers, rows, questions and checks are unset.

boolean
unavailableCode

Why not: “no_decisions” (no episode read), “no_task_review” (no observation was read), “no_task_map” (no upload of the run has a task discovery), “map_incomplete” (the map covers under 90% of the run’s episodes, e.g. after cuts), “partial_run” (the run read under 90% of the discovered episodes) or “invalid_input”.

string
unavailableReason

Why not, in a sentence.

string
version

“review-health-v1”.

string
thresholdsSha256

Sha256 of the frozen thresholds (CurationBench’s THRESHOLDS_SHA256).

string
prepareOperations

Accounts/{account}/operations/{operation}: the prepare runs whose task discovery it read, one per upload.

Array<string>
episodeCount

Episodes read.

integer format: int32
reviewedCount

Of them, episodes whose observation was read.

integer format: int32
removedCount

Removals.

integer format: int32
removalRate

Removed_count / episode_count.

number format: double
mapSucceededCount

Episodes the discovery map calls successful.

integer format: int32
mapSucceededShare

Map_succeeded_count / episode_count.

number format: double
gap

The kept share less the share the map calls successful.

number format: double
removedCompletedCount

Removals whose observation says the task was completed (they deviated).

integer format: int32
deviatesCompletedShare

Removed_completed_count / removed_count.

number format: double
mapCoverage

Share of the run’s episodes the map covers.

number format: double
groupingAgreement

Share of the run’s episodes judged against a Task linked to their own discovered task.

number format: double
contradictionChecked

The contradiction rule ran: false when grouping_agreement is under 0.9.

boolean
tasks

Per task, largest first.

Array<object>

One task’s numbers.

object
task

The task’s display name in the discovery, else the Task’s label.

string
episodeCount

Its episodes in the run.

integer format: int32
removedCount

Of them, removals.

integer format: int32
mapSucceededCount

Of them, episodes the discovery map calls successful.

integer format: int32
removalRate

Removed_count / episode_count.

number format: double
mapSucceededShare

Map_succeeded_count / episode_count.

number format: double
gap

The kept share less the share the map calls successful.

number format: double
questions

At most three questions, in the rules’ order.

Array<object>

One question for a person, with example episodes.

object
rule

The rule that asks it: “contradiction” (tasks may be mixed), “under_removal”, “over_removal” or “outcome_data”.

string
question

The question, in a sentence.

string
detail

Why it is asked, with the numbers.

string
groups

Contradiction: the tasks it fires on.

Array<object>

A task (or variant) the contradiction rule fires on.

object
task

The task’s display name in the discovery.

string
variant

The variant’s name; empty for a whole task.

string
episodeCount

Its episodes in the run.

integer format: int32
removedCount

Of them, removals: a failing finding.

integer format: int32
mapSucceededCount

Of them, episodes the discovery map calls successful.

integer format: int32
referenceEpisodeIds

The SUCCESS references most of them were judged against, by episode id: a Task’s reference can live in another dataset.

Array<string>
episodes

Example episodes.

Array<string>
action

Where it is answered: “tasks” (the task grouping and the references), “miss_check” (the miss check below), or empty.

string
moreQuestions

The rules of questions past the three, not shown.

Array<string>
spotCheck

The spot check.

object
episodes

The episodes, at most ten, picked reproducibly from the pool.

Array<string>
poolCount

Every removal the map calls successful.

integer format: int32
flagErrorCount

Wrong removals among the episodes that say the references or the Task may not fit the dataset (4).

integer format: int32
missCheck

The miss check; unset unless the run keeps too much.

object
episodes

The episodes shown, at most eight.

Array<string>
restEpisodes

The rest of the queue, in removal-score order.

Array<string>
poolCount

The whole queue.

integer format: int32
confirmCount

Removals among the shown episodes that say the rest likely go too (5).

integer format: int32
unpublishedCount

Episodes whose proposed labels did not publish. Their findings stand; a run above zero is partial.

integer format: int32
unpublishedProposals

The first 100 of those episodes, each with why.

Array<object>

An episode whose proposed labels did not publish.

object
episode

Accounts/{account}/datasets/{dataset}/episodes/{episode}

string
reason

Why, as the publisher answered.

string
pending

Nobody saw the publication end: it may still land. Running the same reading again replays it.

boolean
Example
{
"state": "STATE_UNSPECIFIED",
"creator": {
"kind": "KIND_UNSPECIFIED",
"attribution": {
"authentication": "AUTHENTICATION_UNSPECIFIED",
"credentialOwner": "CREDENTIAL_OWNER_UNSPECIFIED"
}
}
}

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object
code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32
message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string
details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object
@type

The type of the serialized message.

string
key
additional properties
any
Example generated
{
"code": 1,
"message": "example",
"details": [
{
"@type": "example"
}
]
}