Convert3D
Convert3D

API

API authentication

Authenticate API requests with a bearer token

The Convert3D cloud API uses bearer token authentication.

Header

Send your token in the Authorization header:

Authorization: Bearer YOUR_API_TOKEN

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}`,
  },
});

Python

import os
import requests

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

Token errors

If the header is missing:

{
  "error": "Missing Authorization header"
}

If the token is invalid:

{
  "error": "Invalid API token"
}

Both responses use HTTP 401.

Credits and quota

API conversions may consume API conversion credits. If a paid account has no remaining quota, the API returns HTTP 429.

{
  "error": "API conversion quota exhausted. Upgrade your plan at https://convert3d.org/convert3dapi"
}

If a conversion fails after a credit is consumed, Convert3D attempts to refund that credit.