Skip to content
Qualia Docs

Checks_GetCheck

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

Gets one check.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
account
required
string

The account id.

check
required
string

The check id.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json

A check the server runs over a dataset. Every account has the same four; the {check} id is the kind as a lowercase slug: episode-rules, mixture, reach, vlm. Everything a check needs (its results and reference ranges) lives under it.

Served by qds-api.

object
name

Accounts/{account}/checks/{check}

string
kind

Which check it is.

string format: enum
Allowed values: KIND_UNSPECIFIED EPISODE_RULES MIXTURE REACH VLM HEURISTIC
description

One sentence: what it checks.

string
datasetKinds

The dataset kinds it runs on.

Array<string>
Allowed values: KIND_UNSPECIFIED UPLOAD MIXTURE MERGED
storesResults

Whether the check stores a CheckResult per episode. Only reach does. A check’s computed values are its source and its issues are alerts derived from them: reach’s source is its results; the episode rules’ is Episode.metrics and their reference ranges; so their results collection is empty. The VLM check’s readings are kept with its issues, which are what it reports: each issue it raised carries its reading (Issue.finding).

boolean
runnable

Whether this deployment can run it. False only for vlm where the deployment has no VLM check pipeline template or no source of published tasks: RunCheck on it is then FAILED_PRECONDITION. A client offers a run only where it is true.

boolean
Example 
{
  "kind": "KIND_UNSPECIFIED",
  "datasetKinds": [
    "KIND_UNSPECIFIED"
  ]
}

default

Section titled “default ”

Default error response

Media type application/json
One of:
API error

A refusal from the API itself.

object
code
required

The gRPC code name in upper case, e.g. NOT_FOUND.

string
message
required
string
retryable
required

Whether the same call may succeed if retried.

boolean
details
required

Empty, except when a dataset copy or move is refused: then one google.rpc.ErrorInfo with the refusal’s reason code, its domain and, in metadata, the datasets it names.

Array<object>
object
Example generated
{
  "code": "example",
  "message": "example",
  "retryable": true,
  "details": [
    {}
  ]
}