Batch jobs
Clusters
Environments
Node pools
Node pool bindings
curl --request GET \
--url https://api.fireworks.ai/v1/accounts/{account_id}/batchJobs \
--header 'Authorization: Bearer <token>'{
"batchJobs": [
{
"nodePoolId": "<string>",
"name": "<string>",
"displayName": "<string>",
"createTime": "2023-11-07T05:31:56Z",
"startTime": "2023-11-07T05:31:56Z",
"endTime": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"environmentId": "<string>",
"snapshotId": "<string>",
"numRanks": 123,
"envVars": {},
"role": "<string>",
"pythonExecutor": {
"targetType": "TARGET_TYPE_UNSPECIFIED",
"target": "<string>",
"args": [
"<string>"
]
},
"notebookExecutor": {
"notebookFilename": "<string>"
},
"shellExecutor": {
"command": "<string>"
},
"imageRef": "<string>",
"annotations": {},
"state": "STATE_UNSPECIFIED",
"status": "<string>",
"shared": true,
"updateTime": "2023-11-07T05:31:56Z"
}
],
"nextPageToken": "<string>",
"totalSize": 123
}List Batch Jobs
curl --request GET \
--url https://api.fireworks.ai/v1/accounts/{account_id}/batchJobs \
--header 'Authorization: Bearer <token>'{
"batchJobs": [
{
"nodePoolId": "<string>",
"name": "<string>",
"displayName": "<string>",
"createTime": "2023-11-07T05:31:56Z",
"startTime": "2023-11-07T05:31:56Z",
"endTime": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"environmentId": "<string>",
"snapshotId": "<string>",
"numRanks": 123,
"envVars": {},
"role": "<string>",
"pythonExecutor": {
"targetType": "TARGET_TYPE_UNSPECIFIED",
"target": "<string>",
"args": [
"<string>"
]
},
"notebookExecutor": {
"notebookFilename": "<string>"
},
"shellExecutor": {
"command": "<string>"
},
"imageRef": "<string>",
"annotations": {},
"state": "STATE_UNSPECIFIED",
"status": "<string>",
"shared": true,
"updateTime": "2023-11-07T05:31:56Z"
}
],
"nextPageToken": "<string>",
"totalSize": 123
}Authorizations
Bearer authentication using your Fireworks API key. Format: Bearer <API_KEY>
Path Parameters
The Account Id
Query Parameters
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.
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.
Only batch jobs satisfying the provided filter (if specified) will be returned. See https://google.aip.dev/160 for the filter grammar.
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".
The fields to be returned in the response. If empty or "*", all fields will be returned.
Response
A successful response.
Show child attributes
Show child attributes
Human-readable display name of the batch job. e.g. "My Batch Job" Must be fewer than 64 characters long.
The creation time of the batch job.
The time when the batch job started running.
The time when the batch job completed, failed, or was cancelled.
The email address of the user who created this batch job.
The ID of the environment that this batch job should use. e.g. my-env If specified, image_ref must not be specified.
The ID of the snapshot used by this batch job. If specified, environment_id must be specified and image_ref must not be specified.
For GPU node pools: one GPU per rank w/ host packing, for CPU node pools: one host per rank.
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.
Execute a Python process.
Show child attributes
Show child attributes
The type of Python target to run.
TARGET_TYPE_UNSPECIFIED, MODULE, FILENAME A Python module or filename depending on TargetType.
Command line arguments to pass to the Python process.
The container image used by this job. If specified, environment_id and snapshot_id must not be specified.
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.
Show child attributes
Show child attributes
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.
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.
The update time for the batch job.
A token, which can be sent as page_token to retrieve the next page.
If this field is omitted, there are no subsequent pages.
The total number of batch jobs.
Was this page helpful?