API reference

200 The pictures are ready. data holds one signed link for each picture that was made.

• created integer Required

• data list of object Required

  • url string Required

• easyimage object Required

  • job_ids list of string Required

  • credits integer Required

  • expires_at integer Required When the links in data stop working.

  • failed list of string Optional The ids of pictures that failed or were refused. They are left out of data.

202 The pictures are not ready yet. data holds the jobs. Poll each one, or wait for a webhook.

• object string Required One of: list.

• data list of object Required

  • id string Required

  • object string Required One of: job.

  • operation string Required One of: generation, edit, background_removal, upscale, outpaint, erase, image_upload, other.

  • status string Required One of: queued, running, succeeded, failed, refused, canceled, expired.

  • progress object Required Where a job is: the step it is on and how many steps it has.

    • step integer Required

    • step_total integer Required

  • created_at integer Required

  • finished_at integer or null Required

  • credits integer Required

  • error object or null Required

    • code string Required One of: try_again, content_refused, output_refused, unavailable.

    • message string Required

  • result object or null Required

    • images list of object Required

      • id string Required

      • url string Required

      • expires_at integer Required

      • width integer Required at least 1.

      • height integer Required at least 1.

      • content_type string Required

curl

curl -X POST https://easyimage.ae/v1/images/generations \
  -H "Authorization: Bearer $EASYIMAGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"prompt":"A lighthouse on a cliff at dusk, soft light","size":"1024x1024","n":1}'

JavaScript

const response = await fetch("https://easyimage.ae/v1/images/generations", {
  method: "POST",
  body: JSON.stringify({
    "prompt": "A lighthouse on a cliff at dusk, soft light",
    "size": "1024x1024",
    "n": 1
  }),
  headers: {
    Authorization: `Bearer ${process.env.EASYIMAGE_API_KEY}`,
    "Content-Type": "application/json",
  },
});
console.log(await response.json());

SDK

import OpenAI from "openai";

const client = new OpenAI({
  apiKey: process.env.EASYIMAGE_API_KEY,
  baseURL: "https://easyimage.ae/v1",
});

const result = await client.images.generate({
    "prompt": "A lighthouse on a cliff at dusk, soft light",
    "size": "1024x1024",
    "n": 1
  });
console.log(result.data[0].url);

200 The picture is ready. data holds one signed link.

• created integer Required

• data list of object Required

  • url string Required

• easyimage object Required

  • job_ids list of string Required

  • credits integer Required

  • expires_at integer Required When the links in data stop working.

  • failed list of string Optional The ids of pictures that failed or were refused. They are left out of data.

202 The picture is not ready yet. data holds the job. Poll it, or wait for a webhook.

• object string Required One of: list.

• data list of object Required

  • id string Required

  • object string Required One of: job.

  • operation string Required One of: generation, edit, background_removal, upscale, outpaint, erase, image_upload, other.

  • status string Required One of: queued, running, succeeded, failed, refused, canceled, expired.

  • progress object Required Where a job is: the step it is on and how many steps it has.

    • step integer Required

    • step_total integer Required

  • created_at integer Required

  • finished_at integer or null Required

  • credits integer Required

  • error object or null Required

    • code string Required One of: try_again, content_refused, output_refused, unavailable.

    • message string Required

  • result object or null Required

    • images list of object Required

      • id string Required

      • url string Required

      • expires_at integer Required

      • width integer Required at least 1.

      • height integer Required at least 1.

      • content_type string Required

curl

curl -X POST https://easyimage.ae/v1/images/edits \
  -H "Authorization: Bearer $EASYIMAGE_API_KEY" \
  -F 'image=@photo.png' \
  -F 'prompt=Make the sky a warm evening orange'

JavaScript

import { readFile } from "node:fs/promises";

const form = new FormData();
form.append("image", new Blob([await readFile("photo.png")]), "photo.png");
form.append("prompt", "Make the sky a warm evening orange");

const response = await fetch("https://easyimage.ae/v1/images/edits", {
  method: "POST",
  body: form,
  headers: {
    Authorization: `Bearer ${process.env.EASYIMAGE_API_KEY}`,
  },
});
console.log(await response.json());

SDK

import fs from "node:fs";
import OpenAI from "openai";

const client = new OpenAI({
  apiKey: process.env.EASYIMAGE_API_KEY,
  baseURL: "https://easyimage.ae/v1",
});

const result = await client.images.edit({
  image: fs.createReadStream("photo.png"),
  prompt: "Make the sky a warm evening orange",
});
console.log(result.data[0].url);

200 The job ended inside the wait you asked for with Prefer: wait. The body is the finished job.

• id string Required

• object string Required One of: job.

• operation string Required One of: generation, edit, background_removal, upscale, outpaint, erase, image_upload, other.

• status string Required One of: queued, running, succeeded, failed, refused, canceled, expired.

• progress object Required Where a job is: the step it is on and how many steps it has.

  • step integer Required

  • step_total integer Required

• created_at integer Required

• finished_at integer or null Required

• credits integer Required

• error object or null Required

  • code string Required One of: try_again, content_refused, output_refused, unavailable.

  • message string Required

• result object or null Required

  • images list of object Required

    • id string Required

    • url string Required

    • expires_at integer Required

    • width integer Required at least 1.

    • height integer Required at least 1.

    • content_type string Required

202 The job was accepted and is still running. Poll it, or wait for a webhook. The Location header names the job.

• id string Required

• object string Required One of: job.

• operation string Required One of: generation, edit, background_removal, upscale, outpaint, erase, image_upload, other.

• status string Required One of: queued, running, succeeded, failed, refused, canceled, expired.

• progress object Required Where a job is: the step it is on and how many steps it has.

  • step integer Required

  • step_total integer Required

• created_at integer Required

• finished_at integer or null Required

• credits integer Required

• error object or null Required

  • code string Required One of: try_again, content_refused, output_refused, unavailable.

  • message string Required

• result object or null Required

  • images list of object Required

    • id string Required

    • url string Required

    • expires_at integer Required

    • width integer Required at least 1.

    • height integer Required at least 1.

    • content_type string Required

curl

curl -X POST https://easyimage.ae/v1/images/background-removal \
  -H "Authorization: Bearer $EASYIMAGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"image_id":"0192f3a4-7b6c-7d2e-8f10-3a4b5c6d7e8f"}'

JavaScript

const response = await fetch("https://easyimage.ae/v1/images/background-removal", {
  method: "POST",
  body: JSON.stringify({
    "image_id": "0192f3a4-7b6c-7d2e-8f10-3a4b5c6d7e8f"
  }),
  headers: {
    Authorization: `Bearer ${process.env.EASYIMAGE_API_KEY}`,
    "Content-Type": "application/json",
  },
});
console.log(await response.json());

200 The job ended inside the wait you asked for with Prefer: wait. The body is the finished job.

• id string Required

• object string Required One of: job.

• operation string Required One of: generation, edit, background_removal, upscale, outpaint, erase, image_upload, other.

• status string Required One of: queued, running, succeeded, failed, refused, canceled, expired.

• progress object Required Where a job is: the step it is on and how many steps it has.

  • step integer Required

  • step_total integer Required

• created_at integer Required

• finished_at integer or null Required

• credits integer Required

• error object or null Required

  • code string Required One of: try_again, content_refused, output_refused, unavailable.

  • message string Required

• result object or null Required

  • images list of object Required

    • id string Required

    • url string Required

    • expires_at integer Required

    • width integer Required at least 1.

    • height integer Required at least 1.

    • content_type string Required

202 The job was accepted and is still running. Poll it, or wait for a webhook. The Location header names the job.

• id string Required

• object string Required One of: job.

• operation string Required One of: generation, edit, background_removal, upscale, outpaint, erase, image_upload, other.

• status string Required One of: queued, running, succeeded, failed, refused, canceled, expired.

• progress object Required Where a job is: the step it is on and how many steps it has.

  • step integer Required

  • step_total integer Required

• created_at integer Required

• finished_at integer or null Required

• credits integer Required

• error object or null Required

  • code string Required One of: try_again, content_refused, output_refused, unavailable.

  • message string Required

• result object or null Required

  • images list of object Required

    • id string Required

    • url string Required

    • expires_at integer Required

    • width integer Required at least 1.

    • height integer Required at least 1.

    • content_type string Required

curl

curl -X POST https://easyimage.ae/v1/images/upscale \
  -H "Authorization: Bearer $EASYIMAGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"image_id":"0192f3a4-7b6c-7d2e-8f10-3a4b5c6d7e8f","mode":"2x"}'

JavaScript

const response = await fetch("https://easyimage.ae/v1/images/upscale", {
  method: "POST",
  body: JSON.stringify({
    "image_id": "0192f3a4-7b6c-7d2e-8f10-3a4b5c6d7e8f",
    "mode": "2x"
  }),
  headers: {
    Authorization: `Bearer ${process.env.EASYIMAGE_API_KEY}`,
    "Content-Type": "application/json",
  },
});
console.log(await response.json());

200 The job ended inside the wait you asked for with Prefer: wait. The body is the finished job.

• id string Required

• object string Required One of: job.

• operation string Required One of: generation, edit, background_removal, upscale, outpaint, erase, image_upload, other.

• status string Required One of: queued, running, succeeded, failed, refused, canceled, expired.

• progress object Required Where a job is: the step it is on and how many steps it has.

  • step integer Required

  • step_total integer Required

• created_at integer Required

• finished_at integer or null Required

• credits integer Required

• error object or null Required

  • code string Required One of: try_again, content_refused, output_refused, unavailable.

  • message string Required

• result object or null Required

  • images list of object Required

    • id string Required

    • url string Required

    • expires_at integer Required

    • width integer Required at least 1.

    • height integer Required at least 1.

    • content_type string Required

202 The job was accepted and is still running. Poll it, or wait for a webhook. The Location header names the job.

• id string Required

• object string Required One of: job.

• operation string Required One of: generation, edit, background_removal, upscale, outpaint, erase, image_upload, other.

• status string Required One of: queued, running, succeeded, failed, refused, canceled, expired.

• progress object Required Where a job is: the step it is on and how many steps it has.

  • step integer Required

  • step_total integer Required

• created_at integer Required

• finished_at integer or null Required

• credits integer Required

• error object or null Required

  • code string Required One of: try_again, content_refused, output_refused, unavailable.

  • message string Required

• result object or null Required

  • images list of object Required

    • id string Required

    • url string Required

    • expires_at integer Required

    • width integer Required at least 1.

    • height integer Required at least 1.

    • content_type string Required

curl

curl -X POST https://easyimage.ae/v1/images/outpaint \
  -H "Authorization: Bearer $EASYIMAGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"image_id":"0192f3a4-7b6c-7d2e-8f10-3a4b5c6d7e8f","frame":{"left":0,"top":0,"right":2500,"bottom":0},"prompt":"More of the same beach"}'

JavaScript

const response = await fetch("https://easyimage.ae/v1/images/outpaint", {
  method: "POST",
  body: JSON.stringify({
    "image_id": "0192f3a4-7b6c-7d2e-8f10-3a4b5c6d7e8f",
    "frame": {
      "left": 0,
      "top": 0,
      "right": 2500,
      "bottom": 0
    },
    "prompt": "More of the same beach"
  }),
  headers: {
    Authorization: `Bearer ${process.env.EASYIMAGE_API_KEY}`,
    "Content-Type": "application/json",
  },
});
console.log(await response.json());

200 The job ended inside the wait you asked for with Prefer: wait. The body is the finished job.

• id string Required

• object string Required One of: job.

• operation string Required One of: generation, edit, background_removal, upscale, outpaint, erase, image_upload, other.

• status string Required One of: queued, running, succeeded, failed, refused, canceled, expired.

• progress object Required Where a job is: the step it is on and how many steps it has.

  • step integer Required

  • step_total integer Required

• created_at integer Required

• finished_at integer or null Required

• credits integer Required

• error object or null Required

  • code string Required One of: try_again, content_refused, output_refused, unavailable.

  • message string Required

• result object or null Required

  • images list of object Required

    • id string Required

    • url string Required

    • expires_at integer Required

    • width integer Required at least 1.

    • height integer Required at least 1.

    • content_type string Required

202 The job was accepted and is still running. Poll it, or wait for a webhook. The Location header names the job.

• id string Required

• object string Required One of: job.

• operation string Required One of: generation, edit, background_removal, upscale, outpaint, erase, image_upload, other.

• status string Required One of: queued, running, succeeded, failed, refused, canceled, expired.

• progress object Required Where a job is: the step it is on and how many steps it has.

  • step integer Required

  • step_total integer Required

• created_at integer Required

• finished_at integer or null Required

• credits integer Required

• error object or null Required

  • code string Required One of: try_again, content_refused, output_refused, unavailable.

  • message string Required

• result object or null Required

  • images list of object Required

    • id string Required

    • url string Required

    • expires_at integer Required

    • width integer Required at least 1.

    • height integer Required at least 1.

    • content_type string Required

curl

curl -X POST https://easyimage.ae/v1/images/erase \
  -H "Authorization: Bearer $EASYIMAGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"image_id":"0192f3a4-7b6c-7d2e-8f10-3a4b5c6d7e8f","mask":{"v":1,"ops":[{"op":"rect","mode":"paint","x":4000,"y":4000,"w":2000,"h":2000}]}}'

JavaScript

const response = await fetch("https://easyimage.ae/v1/images/erase", {
  method: "POST",
  body: JSON.stringify({
    "image_id": "0192f3a4-7b6c-7d2e-8f10-3a4b5c6d7e8f",
    "mask": {
      "v": 1,
      "ops": [
        {
          "op": "rect",
          "mode": "paint",
          "x": 4000,
          "y": 4000,
          "w": 2000,
          "h": 2000
        }
      ]
    }
  }),
  headers: {
    Authorization: `Bearer ${process.env.EASYIMAGE_API_KEY}`,
    "Content-Type": "application/json",
  },
});
console.log(await response.json());

200 One page of your images.

• object string Required One of: list.

• data list of object Required

  • id string Required

  • object string Required One of: image.

  • operation string Required One of: generation, edit, background_removal, upscale, outpaint, erase, image_upload, other.

  • created_at integer Required

  • width integer Required at least 1.

  • height integer Required at least 1.

• next_cursor object Required

curl

curl https://easyimage.ae/v1/images \
  -H "Authorization: Bearer $EASYIMAGE_API_KEY"

JavaScript

const response = await fetch("https://easyimage.ae/v1/images", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.EASYIMAGE_API_KEY}`,
  },
});
console.log(await response.json());

200 The job.

• id string Required

• object string Required One of: job.

• operation string Required One of: generation, edit, background_removal, upscale, outpaint, erase, image_upload, other.

• status string Required One of: queued, running, succeeded, failed, refused, canceled, expired.

• progress object Required Where a job is: the step it is on and how many steps it has.

  • step integer Required

  • step_total integer Required

• created_at integer Required

• finished_at integer or null Required

• credits integer Required

• error object or null Required

  • code string Required One of: try_again, content_refused, output_refused, unavailable.

  • message string Required

• result object or null Required

  • images list of object Required

    • id string Required

    • url string Required

    • expires_at integer Required

    • width integer Required at least 1.

    • height integer Required at least 1.

    • content_type string Required

curl

curl https://easyimage.ae/v1/jobs/JOB_ID \
  -H "Authorization: Bearer $EASYIMAGE_API_KEY"

JavaScript

const response = await fetch("https://easyimage.ae/v1/jobs/JOB_ID", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.EASYIMAGE_API_KEY}`,
  },
});
console.log(await response.json());

200 What canceling did.

• id string Required

• object string Required One of: job.

• outcome string Required One of: nothing_used, refunded, kept, requested, already_finished.

curl

curl -X POST https://easyimage.ae/v1/jobs/JOB_ID/cancel \
  -H "Authorization: Bearer $EASYIMAGE_API_KEY"

JavaScript

const response = await fetch("https://easyimage.ae/v1/jobs/JOB_ID/cancel", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.EASYIMAGE_API_KEY}`,
  },
});
console.log(await response.json());

202 The batch started. Poll it to see each file.

• id string Required

• object string Required One of: batch.

• tool string Required One of: remove_background, resize, convert.

• created_at integer Required

• stopped boolean Required

• ended boolean Required

• counts object Required How many files of a batch are in each state.

  • waiting integer Required

  • working integer Required

  • done integer Required

  • skipped integer Required

  • refused integer Required

  • failed integer Required

  • stopped integer Required

• items list of object Required

  • position integer Required

  • state string Required One of: waiting, working, done, skipped, refused, failed, stopped.

  • reason string Optional One of: not_found, archived, credentials_restricted, too_large, nothing_to_do, duplicate, upload_refused, try_again, unavailable, no_subject, already_transparent, not_allowed, removed.

  • step integer Optional

  • step_total integer Optional

  • source_id string Optional

  • result_id string Optional

curl

curl -X POST https://easyimage.ae/v1/batches \
  -H "Authorization: Bearer $EASYIMAGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"tool":"remove_background","image_ids":["0192f3a4-7b6c-7d2e-8f10-3a4b5c6d7e8f","0192f3a4-7b6c-7d2e-8f10-3a4b5c6d7e90"]}'

JavaScript

const response = await fetch("https://easyimage.ae/v1/batches", {
  method: "POST",
  body: JSON.stringify({
    "tool": "remove_background",
    "image_ids": [
      "0192f3a4-7b6c-7d2e-8f10-3a4b5c6d7e8f",
      "0192f3a4-7b6c-7d2e-8f10-3a4b5c6d7e90"
    ]
  }),
  headers: {
    Authorization: `Bearer ${process.env.EASYIMAGE_API_KEY}`,
    "Content-Type": "application/json",
  },
});
console.log(await response.json());

200 The batch.

• id string Required

• object string Required One of: batch.

• tool string Required One of: remove_background, resize, convert.

• created_at integer Required

• stopped boolean Required

• ended boolean Required

• counts object Required How many files of a batch are in each state.

  • waiting integer Required

  • working integer Required

  • done integer Required

  • skipped integer Required

  • refused integer Required

  • failed integer Required

  • stopped integer Required

• items list of object Required

  • position integer Required

  • state string Required One of: waiting, working, done, skipped, refused, failed, stopped.

  • reason string Optional One of: not_found, archived, credentials_restricted, too_large, nothing_to_do, duplicate, upload_refused, try_again, unavailable, no_subject, already_transparent, not_allowed, removed.

  • step integer Optional

  • step_total integer Optional

  • source_id string Optional

  • result_id string Optional

curl

curl https://easyimage.ae/v1/batches/BATCH_ID \
  -H "Authorization: Bearer $EASYIMAGE_API_KEY"

JavaScript

const response = await fetch("https://easyimage.ae/v1/batches/BATCH_ID", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.EASYIMAGE_API_KEY}`,
  },
});
console.log(await response.json());

200 What stopping did.

• id string Required

• object string Required One of: batch.

• stopped_now integer Required

• stopping integer Required

• finished integer Required

• already_stopped boolean Required

curl

curl -X POST https://easyimage.ae/v1/batches/BATCH_ID/cancel \
  -H "Authorization: Bearer $EASYIMAGE_API_KEY"

JavaScript

const response = await fetch("https://easyimage.ae/v1/batches/BATCH_ID/cancel", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.EASYIMAGE_API_KEY}`,
  },
});
console.log(await response.json());

200 The usage.

• source string Required One of: free, subscription, pass.

• day object or null Required

  • kind string Required One of: day, month, pass.

  • used integer Required

  • limit integer Required

  • left integer Required

  • resets_at integer or null Required

  • ends_instead boolean Required

  • state string Required One of: normal, slowed, used_up.

• period object or null Required

  • kind string Required One of: day, month, pass.

  • used integer Required

  • limit integer Required

  • left integer Required

  • resets_at integer or null Required

  • ends_instead boolean Required

  • state string Required One of: normal, slowed, used_up.

• tools list of object Required

  • cost_class string Required One of: standard_generation, premium_generation, edit_inpaint, upscale, background_removal.

  • day_used integer Required

  • day_limit integer or null Required

  • period_used integer Required

  • period_limit integer or null Required

  • used_up boolean Required

• slowed_by string or null Required

• free_budget_spent boolean Required

• slow_rule object Required

  • day_percent object Required

  • period_percent object Required

curl

curl https://easyimage.ae/v1/usage \
  -H "Authorization: Bearer $EASYIMAGE_API_KEY"

JavaScript

const response = await fetch("https://easyimage.ae/v1/usage", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.EASYIMAGE_API_KEY}`,
  },
});
console.log(await response.json());

200 The OpenAPI 3.1 document, as JSON.

curl

curl https://easyimage.ae/v1/openapi.json

JavaScript

const response = await fetch("https://easyimage.ae/v1/openapi.json", {
  method: "GET",
});
console.log(await response.json());