API Reference
Image

Image

All methods required to provide an authorization token.

GET /items/images/:id

For ImagineAPI.dev Cloud, full endpoint is (replace :id with the actual image ID):

https://cl.imagineapi.dev/items/images/:id

Returns:

{
    "data": {
        "id": UUID,
        "prompt": string,
        "results": null | string,
        "user_created": string,
        "date_created": string,
        "status": "pending" | "in-progress" | "completed" | "failed",
        "progress": number | null,
        "url": null | string,
        "error": null | string,
        "upscaled_urls": null | string[],
        "upscaled": string[],
        "ref": string | null,
    }
}

POST /items/images

For ImagineAPI.dev Cloud, full endpoint is:

https://cl.imagineapi.dev/items/images

Body:

{
  "prompt": string,
  "ref": string | null,
}

Notes:

  • prompt can be any value supported by Midjourney prompt paramter (opens in a new tab), including image urls.
  • ref can be set to a value of your choosing. It's good way to keep track of your images if you already have an ID in your internal system. Useful especially for webhooks.

Returns:

{
    "data": {
        "id": UUID,
        "prompt": string,
        "results": null | string,
        "user_created": string,
        "date_created": string,
        "status": "pending" | "in-progress" | "completed" | "failed",
        "progress": number | null,
        "url": null | string,
        "error": null | string,
        "upscaled_urls": null | string[],
        "upscaled": string[],
        "ref": string | null,
    }
}