Convert3D
Convert3D

Endpoints

GET /health

API availability check

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

GET /health

Authentication

This endpoint uses the same bearer token header as other API requests.

Examples

curl

curl https://api.convert3d.org/health \
  -H "Authorization: Bearer YOUR_API_TOKEN"

JavaScript

const response = await fetch("https://api.convert3d.org/health", {
  headers: {
    Authorization: `Bearer ${process.env.CONVERT3D_API_TOKEN}`,
  },
});

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

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

Python

import os
import requests

response = requests.get(
    "https://api.convert3d.org/health",
    headers={"Authorization": f"Bearer {os.environ['CONVERT3D_API_TOKEN']}"},
    timeout=30,
)
response.raise_for_status()
print(response.text)

Response

The response body is a small health response. Use HTTP status first:

  • 2xx means the API is reachable.
  • 401 means the token is missing or invalid.
  • 5xx means the API could not serve the health check.