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.

descriptionstring

Description of the Job resource.

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.

statusstring

The current status of the job. The allowed values are: queued, started, deferred, finished, failed.

Changes

Changed in 2 of the 2 revisions of this API.711

Jul 17, 2026a73101579c5c9See the full diff
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added to the / response property allOf list for the response status
  response-property-all-of-added
- ○
  removed from the / response property allOf list for the response status
  response-property-all-of-removed
This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 24, 20249a36b904337972See the full diff
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property ///// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property ///// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property ///// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ○
  added to the / response property allOf list for the response status
  response-property-all-of-added
- ○
  removed from the / response property allOf list for the response status
  response-property-all-of-removed
This revision also has 49 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history