POST
/
training
/
jobs

Body

application/json
task
enum<string>
required

The task type, which can be either classification or segmentation.

Available options:
classification,
segmentation
training_file
string
required

The ID of an uploaded file that contains training data.

See upload file for how to upload a file.

hyperparameters
object | null

The hyperparameters used for the training job.

validation_file
string | null

The ID of an uploaded file that contains validation data.

If you provide this file, the data is used to generate validation metrics periodically during fine-tuning. These metrics can be viewed in the fine-tuning results file. The same data should not be present in both train and validation files.

Response

200 - application/json
created_at
integer
required

The Unix timestamp (in seconds) for when the training job was created.

id
string
required

The object identifier, which can be referenced in the API endpoints.

status
enum<string>
required

The current status of the training job, which can be either initializing, downloading_files, validating_files, queued, running, succeeded, failed, or cancelled.

Available options:
initializing,
downloading_files,
validating_files,
queued,
running,
succeeded,
failed,
cancelled
task
enum<string>
required

The task type, which can be either classification or segmentation.

Available options:
classification,
segmentation
training_file
string
required

The ID of an uploaded file that contains training data.

See upload file for how to upload a file.

error
string | null

For training jobs that have failed, this will contain more information on the cause of the failure.

finished_at
integer | null

The Unix timestamp (in seconds) for when the training job was finished.

The value will be null if the training job is still running.

hyperparameters
object | null

The hyperparameters used for the training job.

trained_model
string | null

The name of the trained model that is being created.

The value will be null if the training job is still running.

validation_file
string | null

The ID of an uploaded file that contains validation data.

If you provide this file, the data is used to generate validation metrics periodically during fine-tuning. These metrics can be viewed in the fine-tuning results file. The same data should not be present in both train and validation files.