Skip to main content
POST
Generate traces from test cases

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
testIds
string[]

Array of test IDs to generate traces for (will process all test cases in these tests)

Example:
testCaseIds
string[]

Array of test case IDs to generate traces for

Example:
versionId
string

Version ID containing the endpoint connection configuration. Provide this or productId.

Example:

"ver_123"

productId
string

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

Example:

"prod_123"

metricIds
string[]

Optional array of metric IDs to evaluate after inference generation. If provided, evaluations will be triggered automatically.

Example:

Response

Inference generation job queued successfully

jobId
string
versionId
string

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

message
string
testCaseCount
integer
warnings
string[]

Non-fatal problems with the queued run, e.g. attached files the endpoint connection template cannot deliver. Empty when there are none.

runId
string

The run this launch opened. Every launch opens one, whether or not it evaluates a metric.