Skip to content

Update the status of a prompt run against assets

Request

Update an AssetPromptBatchJob.

Stop an in-progress job by patching status to STOPPED, or restart a stopped job by patching status to STARTED.

Security
bearerToken
Path
idstringrequired

The unique ID of the AssetPromptBatchJob

Bodyapplication/jsonrequired
statusstring or nullrequired

The status of the job

Enum:"STARTED""STOPPED"
curl -i -X PATCH \
  'https://api-v2.dash.app/asset-prompt-batch-jobs/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "status": "STARTED"
  }'

Responses

Success

Bodyapplication/json
idstringrequired

Unique identifier of the job that has been created

Example:"be161977-d44e-4888-af3c-66522e223963"
accountIdstringrequired

The ID of the account the job is happening in

Example:"cfb665ca-ce35-4418-b9d5-70ee815db4bd"
creatorIdstringrequired

The ID of the User who created the job

Example:"google-oauth2|110955770826801837334"
typestringrequired

The job type

Value:"IN_PROGRESS"
Discriminator
progressobjectrequired
statusstringrequired
Enum:"PENDING""STARTING""STARTED""STOPPING"
resultobjectrequired

The outputs generated so far, allowing partial results to be displayed while the job is still running. The successes and failures are empty until any assets have been processed.

Response
{
  "id": "be161977-d44e-4888-af3c-66522e223963",
  "accountId": "cfb665ca-ce35-4418-b9d5-70ee815db4bd",
  "creatorId": "google-oauth2|110955770826801837334",
  "type": "IN_PROGRESS",
  "progress": {
    "steps": [ … ]
  },
  "status": "PENDING",
  "result": {
    "successes": { … },
    "failures": { … }
  }
}