Batch Jobs
Create Batch Job
POST
/
v1
/
accounts
/
{account_id}
/
batchJobs
curl --request POST \
--url https://api.fireworks.ai/v1/accounts/{account_id}/batchJobs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"displayName": "<string>",
"nodePoolId": "<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": {},
"shared": true
}'
{
"name": "<string>",
"displayName": "<string>",
"createTime": "2023-11-07T05:31:56Z",
"startTime": "2023-11-07T05:31:56Z",
"endTime": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"nodePoolId": "<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"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
The Account Id
Body
application/json
The properties of the batch job being created.
The body is of type object
.
Response
200 - application/json
A successful response.
The response is of type object
.
Was this page helpful?
curl --request POST \
--url https://api.fireworks.ai/v1/accounts/{account_id}/batchJobs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"displayName": "<string>",
"nodePoolId": "<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": {},
"shared": true
}'
{
"name": "<string>",
"displayName": "<string>",
"createTime": "2023-11-07T05:31:56Z",
"startTime": "2023-11-07T05:31:56Z",
"endTime": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"nodePoolId": "<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"
}
Assistant
Responses are generated using AI and may contain mistakes.