Get Progress - ImaginePro

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

messageId

string

required

the unique identifier of our AI image generation request

Example:

d15c1541-229a-442b-9873-d3494dede12a

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200Success

application/json

Body

success

string

required

The unique identifier for the current request.

prompt

string

required

The original prompt for the image generation task.

createdAt

string

required

The timestamp of the job creation.

updatedAt

string

required

The timestamp of the job update.

originalUrl

string

optional

The original image URL in the Discord server, only valid for 24 hours.

uri

string

optional

The generated image URL in ImaginePro CDN.

progress

string

optional

Task progress, out of 100.

status

string

optional

The status of the task, either PROCESSING, QUEUED, DONE, FAIL.

error

string

optional

Error message, if any.

buttons

array[string]

optional

The valid button values for the subsequential actions.

images

array[string]

optional

A list of splited images exactly the same as U1/2/3/4
Please note that this is only work for Imagine.

originalMessageId

string

optional

The unique identifier for the original Imagine task.

ref

string

optional

The reference value you passed in the previous requests.

Example

{
    "messageId": "your-button-message-id",
    "prompt": "A little cat running on the grass",
    "originalUrl": "https://cdn.discordapp.com/attachments/123/123/123.png",
    "uri": "https://cdn.imaginepro.ai/storage/123/123/123.png",
    "progress": 100,
    "status": "DONE",
    "createdAt": "2023-08-01T14:03:01.817Z",
    "updatedAt": "2023-08-01T14:03:01.817Z",
    "buttons": [
        "U1",
        "U2",
        "U3",
        "U4",
        "🔄",
        "V1",
        "V2",
        "V3",
        "V4",
        "Zoom Out 2x",
        "Zoom Out 1.5x",
        "Vary (Strong)",
        "Vary (Subtle)"
    ],
    "images": [
        "https://cdn.imaginepro.ai/storage/123/123/123-1.png",
        "https://cdn.imaginepro.ai/storage/123/123/123-2.png",
        "https://cdn.imaginepro.ai/storage/123/123/123-3.png",
        "https://cdn.imaginepro.ai/storage/123/123/123-4.png"
    ],
    "originatingMessageId": "your-message-id",
    "ref": ""
}