Create Batch Job
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The Account Id
Body
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.
Human-readable display name of the batch job. e.g. "My Batch Job" Must be fewer than 64 characters long.
The ID of the environment that this batch job should use. e.g. my-env If specified, image_ref must not be specified.
Environment variables to be passed during this job's execution.
The container image used by this job. If specified, environment_id and snapshot_id must not be specified.
Execute a notebook file.
For GPU node pools: one GPU per rank w/ host packing, for CPU node pools: one host per rank.
Execute a Python process.
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.
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.
Execute a shell script.
The ID of the snapshot used by this batch job. If specified, environment_id must be specified and image_ref must not be specified.
The current state of the batch job.
STATE_UNSPECIFIED, CREATING, QUEUED, PENDING, RUNNING, COMPLETED, FAILED, CANCELLING, CANCELLED, DELETING Response
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.
The email address of the user who created this batch job.
The creation time of the batch job.
Human-readable display name of the batch job. e.g. "My Batch Job" Must be fewer than 64 characters long.
The time when the batch job completed, failed, or was cancelled.
The ID of the environment that this batch job should use. e.g. my-env If specified, image_ref must not be specified.
Environment variables to be passed during this job's execution.
The container image used by this job. If specified, environment_id and snapshot_id must not be specified.
Execute a notebook file.
For GPU node pools: one GPU per rank w/ host packing, for CPU node pools: one host per rank.
Execute a Python process.
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.
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.
Execute a shell script.
The ID of the snapshot used by this batch job. If specified, environment_id must be specified and image_ref must not be specified.
The time when the batch job started running.
The current state of the batch job.
STATE_UNSPECIFIED, CREATING, QUEUED, PENDING, RUNNING, COMPLETED, FAILED, CANCELLING, CANCELLED, DELETING Detailed information about the current status of the batch job.
Was this page helpful?