Skip to main content
A check asks an agent to inspect tasks against a quality rubric. It can read a local directory or an existing dataset version.
For every method’s inputs, return values, and language differences, see the checks method reference.
Examples reuse the SDK setup. Run Python snippets inside the async function shown in the Python guide.

Create and wait

For a published dataset:
Choose one source. A local check does not first publish a dataset.

Configuration

TypeScript places these alongside source in the input object. Python takes keyword arguments.

Read current defaults

Defaults include agent, model, rubric, prompt, effort, and provider. Omit agent to read the current platform defaults. Pass it to read a specific harness’s check model default and that model’s default effort. See supported models and efforts. Check prompt tokens are {task_path}, {file_tree}, and {criteria_guidance}. They differ from analysis prompt tokens.

Understand the result

Each task can be queued, running, completed, or failed. The check becomes completed once every task settles, even if a task failed.
The API returns no overall verdict or separate execution flag. Read summary and checks for findings and evidence. not_applicable can mean the criterion does not apply or essential evidence is unavailable; its explanation distinguishes the two. Missing evidence leaves that part of the task’s behavior unresolved. Older records may use unknown for that case; see how to read a check result.

Read and follow checks

Watch options are onProgress, pollIntervalMs, signal in TypeScript; on_progress, poll_interval_s, timeout_s in Python. Polling starts at 2 seconds and slows to 30 seconds while unchanged.

Inspect files and transcripts

For TypeScript transcripts, since is an inclusive nonnegative event index. Artifact selectors are trace-stdout, trace-stderr, and agent-home; the last returns a file map, the others text. Missing content is null. Filesystem methods and download options are shared with trials and analyses.

Share a check

Only the creator can manage shares. Sharing by email can send invitations. See sharing.
Last modified on November 9, 2026