Skip to main content
Use the CLI guides for the complete documented run, evaluate and train journey. This HTTP reference is a deliberately curated subset: 22 reviewed customer operations, not an inventory of every endpoint used by the CLI. You do not need an SDK to use either surface.

​
Base URL

Send a user-scoped bearer credential:
Keep the token in your secret manager. The examples refer to $SYNTH_ACCESS_TOKEN and never read a project .env. An opaque personal access token also requires its UUID-valued owner in SYNTH_USER_ID. Personal access token list, create, and revoke operations require an interactive user JWT. A personal access token can authenticate ordinary customer work but cannot administer other tokens.

​
Playground safety

The generated reference shows request shapes and copyable curl examples. Run them from your own environment with a user-scoped credential and preserve the idempotency key when retrying a mutation.

​
What is included

  • personal access token metadata and lifecycle;
  • task and dataset creation, discovery, immutable version resolution, and mutable metadata or visibility updates;
  • bounded task-version execution matrices, historical executions, lifecycle events, scores, failures, and artifacts;
  • hosted Harbor-compatible job validation, execution, evidence, bundles, and cancellation; and
  • current rolling quota.
Only reviewed customer resources appear in this reference. The curated surface keeps customer identity, Registry resources, executions, evidence, and quota focused on the workflows you use. Use the generated endpoint groups in the left navigation to inspect request and response schemas for the curated reference.