TRtrainy
Runs

Create a new run

Creates a new run in the specified project. If the project doesn't exist, it will be created. If externalId is provided and a run with that ID already exists, the existing run is returned (Neptune-style resume for multi-node distributed training).

post/api/runs/create

Request

  • Base URL
    https://pluto-api.trainy.ai
  • Auth
    HTTP bearer

Request body

runNamestring required

Name of the run

projectNamestring required

Name of the project

externalIdstring nullable

User-provided run ID for multi-node distributed training. If provided and a run with this ID exists, the existing run is returned.

tagsstring[] nullable

Tags for the run (max 50)

loggerSettingsstring nullable

Logger settings as JSON string

systemMetadatastring nullable

System metadata as JSON string

configstring nullable

Run configuration as JSON string

createdAtinteger nullable

Creation timestamp in epoch milliseconds (backfill/migration)

updatedAtinteger nullable

Update timestamp in epoch milliseconds (backfill/migration)

forkRunIdnumber nullable

ID of the run to fork from. Creates a child run that inherits metrics up to forkStep.

forkStepnumber nullable

Step at which to fork. Required when forkRunId is provided. The child run inherits all metrics up to and including this step.

inheritConfigboolean nullable

Whether to inherit config from the parent run (default: true). Only applies when forkRunId is provided.

inheritTagsboolean nullable

Whether to inherit tags from the parent run (default: false). Only applies when forkRunId is provided.

Example request

{
  "runName": "training-run-1",
  "projectName": "my-project",
  "externalId": "my-ddp-run-2024",
  "tags": [
    "experiment",
    "v1"
  ],
  "config": "{\"lr\": 0.001}"
}

Response

Run created successfully

runIdnumber required

Numeric ID of the created run

numbernumber nullable required

Sequential run number within the project (for display IDs)

displayIdstring nullable required

Human-readable display ID (e.g., 'MMP-1')

projectNamestring required

Name of the project

organizationSlugstring required

Organization slug

urlstring required

URL to view the run

resumedboolean required

Whether an existing run was resumed (true) or a new run was created (false)

forkedFromRunIdnumber nullable

ID of the parent run this was forked from (null if not forked)

forkStepnumber nullable

Step at which the fork occurred (null if not forked)

Changes

No recorded changes to this operation across all 1 revision of this API.