Fetch Single Task (most recommended)

Request

Path Params

id

string

required

Example:

b60b24fe-6fa6-42ab-8ac1-e4e971fe6fc2

Header Params

Authorization

string

optional

Example:

Bearer {{api-key}}

Body Params application/x-www-form-urlencoded

object {0}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.cometapi.com/mj/task/b60b24fe-6fa6-42ab-8ac1-e4e971fe6fc2/fetch' \
--header 'Authorization: Bearer {{api-key}}'

Responses

🟢200Success

application/json

Body

id

string

required

Unique identifier for the task

action

string

required

Type of action to execute

customId

string

required

User-defined ID for tracking or association, empty here

botType

string

required

Type of bot used, empty here

prompt

string

required

Original prompt input by user

promptEn

string

required

Translated English prompt, models typically process in English

description

string

required

Description of current task status, such as queue information

state

string

required

Internal status code or identifier

mode

string

required

Task execution mode (e.g., 'fast', 'relax' in Midjourney), empty here

proxy

string

required

Proxy server information used, empty here

submitTime

integer

required

Timestamp when the task was submitted (milliseconds)

startTime

integer

required

Timestamp when the task started processing (milliseconds)

finishTime

integer

required

Timestamp when the task completed (milliseconds)

imageUrl

string

required

URL of the generated image

imageHeight

integer

required

Height of the generated image (pixels)

imageWidth

integer

required

Width of the generated image (pixels)

status

string

required

Final status of the task, 'SUCCESS' indicates success

progress

string

required

Percentage of task completion

failReason

string

required

If task failed, this shows the reason for failure, empty here indicates success

buttons

array [object {5}]

required

Array of interactive buttons related to the generated result

customId

string

required

variation: generate variants

emoji

string

required

Emoji for regeneration

label

string

required

V4: Generate variants based on the fourth image

type

integer

required

Type of button component

style

integer

required

Style of the button

maskBase64

string

required

Base64 encoded mask image data (for image editing like inpainting), empty here

properties

object

required

Contains other properties or metadata related to the task

notifyHook

string

required

Webhook notification URL for receiving task status updates, empty here

flags

integer

required

Internal flags, specific meaning needs to refer to API documentation

messageId

string

required

Message ID associated with this task

messageHash

string

required

Hash value of message content, or hash for identifying image (used for U/V operations), empty here

nonce

string

required

One-time random number to prevent replay attacks or identify requests, empty here

customId

string

required

Custom ID within properties, empty here

finalPrompt

string

required

Final prompt passed to the model after processing

progressMessageId

string

required

Message ID used to display progress updates, empty here

messageContent

string

required

Content of the associated message, empty here

discordInstanceId

string

required

Discord instance ID that processed the request, empty here

discordChannelId

string

required

Discord channel ID where the request originated or results were published, empty here

Example

{
    "id": "string",
    "action": "string",
    "customId": "string",
    "botType": "string",
    "prompt": "string",
    "promptEn": "string",
    "description": "string",
    "state": "string",
    "mode": "string",
    "proxy": "string",
    "submitTime": 0,
    "startTime": 0,
    "finishTime": 0,
    "imageUrl": "string",
    "imageHeight": 0,
    "imageWidth": 0,
    "status": "string",
    "progress": "string",
    "failReason": "string",
    "buttons": [
        {
            "customId": "string",
            "emoji": "string",
            "label": "string",
            "type": 0,
            "style": 0
        }
    ],
    "maskBase64": "string",
    "properties": {
        "notifyHook": "string",
        "flags": 0,
        "messageId": "string",
        "messageHash": "string",
        "nonce": "string",
        "customId": "string",
        "finalPrompt": "string",
        "progressMessageId": "string",
        "messageContent": "string",
        "discordInstanceId": "string",
        "discordChannelId": "string"
    }
}