List Batch Jobs

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

account_id

string

required

The Account Id

Query Parameters

pageSize

integer

The maximum number of batch jobs to return. The maximum page_size is 200, values above 200 will be coerced to 200. If unspecified, the default is 50.

pageToken

string

A page token, received from a previous ListBatchJobs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListBatchJobs must match the call that provided the page token.

filter

string

Only batch jobs satisfying the provided filter (if specified) will be returned. See https://google.aip.dev/160 for the filter grammar.

orderBy

string

A comma-separated list of fields to order by. e.g. "foo,bar" The default sort order is ascending. To specify a descending order for a field, append a " desc" suffix. e.g. "foo desc,bar" Subfields are specified with a "." character. e.g. "foo.bar" If not specified, the default order is by "create_time desc".

Response

200 - application/json

batchJobs

object[]

batchJobs.nodePoolId

string

required

batchJobs.annotations

object

Arbitrary, user-specified metadata. Keys and values must adhere to Kubernetes constraints: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set Additionally, the "fireworks.ai/" prefix is reserved.

batchJobs.createdBy

string

The email address of the user who created this batch job.

batchJobs.createTime

string

The creation time of the batch job.

batchJobs.displayName

string

Human-readable display name of the batch job. e.g. "My Batch Job" Must be fewer than 64 characters long.

batchJobs.endTime

string

The time when the batch job completed, failed, or was cancelled.

batchJobs.environmentId

string

The ID of the environment that this batch job should use. e.g. my-env If specified, image_ref must not be specified.

batchJobs.envVars

object

Environment variables to be passed during this job's execution.

batchJobs.imageRef

string

The container image used by this job. If specified, environment_id and snapshot_id must not be specified.

batchJobs.name

string

batchJobs.notebookExecutor

object

Execute a notebook file.

batchJobs.numRanks

integer

For GPU node pools: one GPU per rank w/ host packing, for CPU node pools: one host per rank.

batchJobs.pythonExecutor

object

Execute a Python process.

batchJobs.role

string

The ARN of the AWS IAM role that the batch job should assume. If not specified, the connection will fall back to the node pool's node_role.

batchJobs.shared

boolean

Whether the batch job is shared with all users in the account. This allows all users to update, delete, clone, and create environments using the batch job.

batchJobs.shellExecutor

object

Execute a shell script.

batchJobs.snapshotId

string

The ID of the snapshot used by this batch job. If specified, environment_id must be specified and image_ref must not be specified.

batchJobs.startTime

string

The time when the batch job started running.

batchJobs.state

enum<string>

default:

STATE_UNSPECIFIED

The current state of the batch job.

Available options:

STATE_UNSPECIFIED,

CREATING,

QUEUED,

PENDING,

RUNNING,

COMPLETED,

FAILED,

CANCELLING,

CANCELLED,

DELETING

batchJobs.status

string

Detailed information about the current status of the batch job.

nextPageToken

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

totalSize

integer

The total number of batch jobs.

Batch Jobs

Clusters

Environments

Node Pools

Node Pool Bindings

Snapshots

AWS IAM Role Bindings

Authorizations

Path Parameters

Query Parameters

Response