Skip to main content
POST
Evaluate a version
You are reading the docs of Galtea 5.16. Read this page in the latest version.

Authorizations

Authorization
string
header
required

API key authorization. Pass your API key in the Authorization header as a Bearer token. Both new (gsk_*) and legacy (gsk-) API keys are accepted, e.g. Authorization: Bearer gsk_... or Authorization: Bearer gsk-....

Body

application/json
versionId
string | null

The version ID to evaluate. Provide this or productId.

Example:

"ver_123"

productId
string | null

Product ID to evaluate when no versionId is given. The product's latest properly configured version is cloned and the evaluation runs against the clone.

Example:

"prod_123"

specificationIds
string[] | null

Optional list of specification IDs to evaluate. If omitted, all product specifications with linked metrics and tests are used.

Example:

Response

Evaluation job queued successfully

jobId
string
required
versionId
string
required

The version the job runs against — the passed versionId, or the id of the clone created when only productId was given.

testCaseCount
integer
required
message
string
required
specifications
object[]
required

Summary of specifications that were evaluated

runId
string | null
required

The run this launch opened.