Delete Images

Send a DELETE request to this endpoint to delete up to 50 generated images and their files at once.

You will need to authenticate to use this API. See authentication.

This action is irreversible. Once an image is deleted, it cannot be recovered.

Request


DELETE https://api.ojo.so/v1/image

Request Body

Parameter	Type	Description
imageIds	array	The ids of the images to delete, 1 to 50

To delete one image, see Delete Image.

cURL


curl --request DELETE \
  --url https://api.ojo.so/v1/image \
  --header 'Authorization: Bearer <your API key>' \
  --header 'Content-Type: application/json' \
  --data '{"imageIds": ["<Image ID>", "<Image ID>"]}'

Python


import requests
 
url = "https://api.ojo.so/v1/image"
payload = {"imageIds": ["<Image ID>", "<Image ID>"]}
headers = {"Authorization": "Bearer <your API key>"}
 
response = requests.delete(url, json=payload, headers=headers)
print(response.text)

JavaScript


const response = await fetch('https://api.ojo.so/v1/image', {
  method: 'DELETE',
  headers: {
    Authorization: 'Bearer <your API key>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ imageIds: ['<Image ID>', '<Image ID>'] }),
});
 
console.log(await response.json());

Response

200

At least one image was deleted. failed names the rest, each with its reason.


{
  "successful": ["image-id-1"],
  "failed": [
    { "imageId": "image-id-2", "reason": "Image not found or already deleted" }
  ],
  "totalProcessed": 2,
  "successCount": 1,
  "failureCount": 1
}

401

Your API key might be invalid or expired.


{
  "error": true,
  "message": "Unauthorized",
  "status": 401,
  "title": "Unauthorized",
  "detail": "Unauthorized"
}

404

None of the images was found, or all were already deleted. A PDF id is not found here either.


{
  "error": true,
  "message": "No image was found to delete",
  "successful": [],
  "failed": [
    { "imageId": "image-id-2", "reason": "Image not found or already deleted" }
  ],
  "totalProcessed": 1,
  "successCount": 0,
  "failureCount": 1,
  "status": 404,
  "title": "Not Found",
  "detail": "No image was found to delete"
}

422

Request payload unprocessable. The reason is in logs: imageIds is missing or empty, or it holds more than 50 ids.


{
  "error": true,
  "message": "Unprocessable Entity",
  "logs": ["imageIds array required in request body"],
  "status": 422,
  "title": "Unprocessable Entity",
  "detail": "Unprocessable Entity"
}

429

You have hit your rate limit. You can view rate limit details here.


{
  "error": true,
  "message": "Render rate limit reached: 60 image and PDF renders per minute",
  "logs": ["Try again in 2 minutes."],
  "code": "rate_limited.render",
  "retryAfter": 120,
  "status": 429,
  "title": "Too Many Requests",
  "detail": "Render rate limit reached: 60 image and PDF renders per minute"
}

500

No image could be deleted. failed names each one and why. Try again later. If the issue persists, please reach out.


{
  "error": true,
  "message": "No image could be deleted",
  "successful": [],
  "failed": [
    { "imageId": "image-id-1", "reason": "Failed to delete image or update record" }
  ],
  "totalProcessed": 1,
  "successCount": 0,
  "failureCount": 1,
  "status": 500,
  "title": "Internal Server Error",
  "detail": "No image could be deleted"
}