v1

latestOpenAPI 3.0.12026-07-17235160320.7 KB

Experiments

Creates a Job resource under the specified Experiment

post/api/v1/experiments/{id}/jobs

Path parameters

idinteger required

ID for the Experiment resource.

Headers

X-Fieldsstring mask

An optional fields mask

Request body

descriptionstring

Description of the Job resource.

queueinteger required

An integer identifying a registered queue.

entrypointinteger required

An integer identifying a registered entry point.

valuesobject

A dictionary of keyword arguments to pass to the Job's Entrypoint.

artifactValuesobject

A dictionary of artifacts to pass to the Job's Entrypoint.

timeoutstring

The maximum alloted time for a job before it times out and is stopped. If omitted, the job timeout will default to 24 hours.

entrypointSnapshotinteger

An integer identifying a snapshot ID associated with the entrypoint. If specified, the snapshotted version of the entrypoint will be used to run the job. If not specified, the job will default to using the latest version of the entrypoint.

Response

Success

idinteger

ID for the Job resource.

snapshotinteger

ID for the underlying Job snapshot.

createdOnstring date-time

Timestamp when the Job resource was created.

snapshotCreatedOnstring date-time

Timestamp when the Job resource snapshot was created.

lastModifiedOnstring date-time

Timestamp when the Job resource was last modified.

latestSnapshotboolean

Whether or not the Job resource is the latest version.

hasDraftboolean

Whether a draft exists for the Job resource.