Delete PDF

Send a DELETE request to this endpoint to delete a generated PDF and its file.

ℹ️

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

⚠️

This action is irreversible. Once a PDF is deleted, it cannot be recovered.

Request


DELETE https://api.ojo.so/v1/pdf/:pdfId

To delete up to 50 PDFs at once, send DELETE https://api.ojo.so/v1/pdf with the JSON body { "pdfIds": ["<PDF ID>", "<PDF ID>"] }. The response lists which ids were deleted and which failed.

cURL


curl --request DELETE \
  --url https://api.ojo.so/v1/pdf/<PDF ID> \
  --header 'Authorization: Bearer <API Key>'

Python


import requests
 
url = "https://api.ojo.so/v1/pdf/<PDF ID>"
headers = {"Authorization": "Bearer <API Key>"}
 
response = requests.delete(url, headers=headers)
print(response.text)

JavaScript


const response = await fetch('https://api.ojo.so/v1/pdf/<PDF ID>', {
  method: 'DELETE',
  headers: { Authorization: 'Bearer <API Key>' },
});
 
console.log(await response.json());

Response

200

PDF successfully deleted.


{
  "deleted": true
}

401

Your API key might be invalid or expired.


{
  "error": true,
  "message": "Unauthorized"
}

404

The specified PDF was not found or has already been deleted. An image id is not found here either.


{
  "error": true,
  "message": "PDF not found"
}

500

An unexpected error occurred. Try again later. If the issue persists, please reach out.


{
  "error": true,
  "message": "Internal Server Error"
}