GET
/
v1
/
accounts
/
{account_id}
/
batchJobs
/
{batch_job_id}

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

batch_job_id
string
required

The Batch Job Id

Response

200 - application/json
nodePoolId
string
required
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.

createdBy
string

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

createTime
string

The creation time of the batch job.

displayName
string

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

endTime
string

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

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.

envVars
object

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

imageRef
string

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

name
string
notebookExecutor
object

Execute a notebook file.

numRanks
integer

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

pythonExecutor
object

Execute a Python process.

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.

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.

shellExecutor
object

Execute a shell script.

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.

startTime
string

The time when the batch job started running.

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
status
string

Detailed information about the current status of the batch job.