Endpoints

GET /health

API availability check

Use GET /health to check that the API is reachable before sending conversion work.

GET /health

Authentication

GET /health does not require authentication. Call it without a token to check that the API is reachable.

Examples

curl

curl https://api.convert3d.org/health

JavaScript

const response = await fetch("https://api.convert3d.org/health");

if (!response.ok) {
  throw new Error(await response.text());
}

console.log(await response.text());

Python

import requests

response = requests.get("https://api.convert3d.org/health", timeout=30)
response.raise_for_status()
print(response.text)

Response

The response body is OK as plain text. Use the HTTP status to decide:

  • 2xx means the API is reachable.
  • 5xx means the API could not serve the health check.