API Documentation

curl -X POST https://www.print-ready.ai/api/images/remove-background \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "image=@product-photo.jpg" \
  -F "quality=plus"

response = requests.post(
    "https://www.print-ready.ai/api/images/remove-background",
    headers={"Authorization": f"Bearer {token}"},
    files={"image": open("product-photo.jpg", "rb")},
    data={"quality": "plus"}
)
print(response.json())

const form = new FormData();
form.append("image", fileInput.files[0]);
form.append("quality", "plus");

const response = await fetch("https://www.print-ready.ai/api/images/remove-background", {
  method: "POST",
  headers: { "Authorization": `Bearer ${token}` },
  body: form
});
console.log(await response.json());

$response = Http::withToken($token)
    ->attach('image', file_get_contents('product-photo.jpg'), 'product-photo.jpg')
    ->post('https://www.print-ready.ai/api/images/remove-background', [
        'quality' => 'plus',
    ]);
dump($response->json());

{
  "success": true,
  "message": "Background removal started. Your image is being processed.",
  "data": {
    "id": 42,
    "batch_id": null,
    "service": "bg_removal",
    "service_variant": "plus",
    "status": "pending",
    "credits_charged": 2,
    "original_filename": "product-photo.jpg",
    "original_size": 1048576,
    "original_dimensions": { "width": 1920, "height": 1080 },
    "processing_params": null,
    "created_at": "2026-03-08T12:00:00.000000Z",
    "updated_at": "2026-03-08T12:00:00.000000Z"
  }
}

curl -X POST https://www.print-ready.ai/api/images/edit \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "image=@landscape.png" \
  -F "instructions=Make the sky more vibrant and add warm sunset tones"

response = requests.post(
    "https://www.print-ready.ai/api/images/edit",
    headers={"Authorization": f"Bearer {token}"},
    files={"image": open("landscape.png", "rb")},
    data={"instructions": "Make the sky more vibrant and add warm sunset tones"}
)
print(response.json())

const form = new FormData();
form.append("image", fileInput.files[0]);
form.append("instructions", "Make the sky more vibrant and add warm sunset tones");

const response = await fetch("https://www.print-ready.ai/api/images/edit", {
  method: "POST",
  headers: { "Authorization": `Bearer ${token}` },
  body: form
});
console.log(await response.json());

$response = Http::withToken($token)
    ->attach('image', file_get_contents('landscape.png'), 'landscape.png')
    ->post('https://www.print-ready.ai/api/images/edit', [
        'instructions' => 'Make the sky more vibrant and add warm sunset tones',
    ]);
dump($response->json());

{
  "success": true,
  "message": "Image editing started. Your image is being processed.",
  "data": {
    "id": 43,
    "batch_id": null,
    "service": "image_edit",
    "service_variant": null,
    "status": "pending",
    "credits_charged": 1,
    "original_filename": "landscape.png",
    "original_size": 2097152,
    "original_dimensions": { "width": 3840, "height": 2160 },
    "processing_params": {
      "instructions": "Make the sky more vibrant and add warm sunset tones"
    },
    "created_at": "2026-03-08T12:01:00.000000Z",
    "updated_at": "2026-03-08T12:01:00.000000Z"
  }
}

curl -X POST https://www.print-ready.ai/api/images/upscale \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "image=@low-res.jpg" \
  -F "scale_factor=4"

response = requests.post(
    "https://www.print-ready.ai/api/images/upscale",
    headers={"Authorization": f"Bearer {token}"},
    files={"image": open("low-res.jpg", "rb")},
    data={"scale_factor": 4}
)
print(response.json())

const form = new FormData();
form.append("image", fileInput.files[0]);
form.append("scale_factor", "4");

const response = await fetch("https://www.print-ready.ai/api/images/upscale", {
  method: "POST",
  headers: { "Authorization": `Bearer ${token}` },
  body: form
});
console.log(await response.json());

$response = Http::withToken($token)
    ->attach('image', file_get_contents('low-res.jpg'), 'low-res.jpg')
    ->post('https://www.print-ready.ai/api/images/upscale', [
        'scale_factor' => 4,
    ]);
dump($response->json());

{
  "success": true,
  "message": "Image upscaling started. Your image is being processed.",
  "data": {
    "id": 44,
    "batch_id": null,
    "service": "upscale",
    "service_variant": null,
    "status": "pending",
    "credits_charged": 1,
    "original_filename": "low-res.jpg",
    "original_size": 524288,
    "original_dimensions": { "width": 640, "height": 480 },
    "processing_params": {
      "scale_factor": 4
    },
    "created_at": "2026-03-08T12:02:00.000000Z",
    "updated_at": "2026-03-08T12:02:00.000000Z"
  }
}