Cancel Job

POST/api/v1/nova/button

The API simulates a Cancel Job button click on the Midjourney channel. This button only available when a generation is working in progress (progress < 100)

Request

Authorization: Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example

Authorization: Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379

messageId

string

required

The unique identifier you get from your previous image generation request.

button

enum<string>

required

The valid button action for Midjourney. The button value needs be within the "buttons" array in /message endpoint's response. E.g. "Cancel Job".

Allowed value:

Cancel Job

ref

string

optional

The reference metadata which will return as part of the webhook.

webhookOverride

string

optional

The webhook URL which the response will send to, the payload of this webhook is same as our Message endpoint.

{
  "messageId": "string",
  "button": "Cancel Job",
  "ref": "string",
  "webhookOverride": "string"
}

Request samples

Responses

Success(200)

HTTP Code: 200

Content Type : JSONapplication/json

success

boolean

required

The status of the request.

messageId

string

required

The messageId of the request, which will be used for querying the progress, sending subsequential actions later, etc.

createdAt

string

required

The timestamp of the job creation.

error

string

optional

The error message, if any

{
  "success": true,
  "messageId": "d15c1541-229a-442b-9873-d3494dede12a",
  "createdAt": "2023-08-01T14:03:01.817Z"
}

Last modified: a month ago