Skip to content
Qualia Docs

Checks_GetCheck

GET
/v1/accounts/{account}/checks/{check}
 
curl --request GET \
  --url https://dev-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

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"
    }
  ]
}