Skip to navigation
API ReferenceDatasets

Start Dataset Checks

View as Markdown

One Check per eligible example, each started as a production run of the agent's live version.

Credits are admitted before anything is created. A retry of the same key returns the same checks and starts only what did not start before.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

project_idstringRequired
dataset_idstringRequired

Request

This endpoint expects an object.
agent_slugstringRequired1-128 characters
idempotency_keystringRequired1-128 characters
dataset_versioninteger or nullOptional>=1
Omit for the latest dataset version.
versionstring or nullOptional<=128 characters

The agent version to check; Checks run on the agent’s live version.

Response

Successful Response
agentVersionstring
checkslist of objects
datasetVersioninteger
notEligiblemap from strings to integers

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error