PATCH
/
v1
/
accounts
/
{account_id}
/
batchJobs
/
{batch_job_id}
Update Batch Job
curl --request PATCH \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/batchJobs/{batch_job_id} \
  --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

​
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

Body

application/json

The properties of the batch job being updated. batch_job.name must be populated with the updated resource's name.

The body is of type object.

Response

200 - application/json

A successful response.

The response is of type object.