Developer Docs

Returns API version info, available endpoints, and docs URL. Useful for health-checks.

curl https://api.skyconvert.net/v1/

Returns all supported input and output formats grouped by converter type.

curl https://api.skyconvert.net/v1/formats \
  -H "X-API-Key: YOUR_API_KEY"

Response

{
  "ok": true,
  "filetypes": {
    "image": {
      "input_formats": ["jpg", "png", "webp", "gif", "bmp", "tiff"],
      "output_formats": ["jpg", "png", "webp", "gif", "bmp", "tiff", "ico"]
    },
    "audio": { "input_formats": [...], "output_formats": [...] },
    ...
  }
}

Upload one or more files. Returns a file_path you can pass directly to /v1/convert.

Request (multipart/form-data)

curl -X POST https://api.skyconvert.net/v1/upload \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "file=@/path/to/image.png"

import requests

resp = requests.post(
    "https://api.skyconvert.net/v1/upload",
    headers={"X-API-Key": "YOUR_API_KEY"},
    files={"file": open("image.png", "rb")},
)
data = resp.json()
file_path = data["files"][0]["file_path"]

const form = new FormData();
form.append("file", fileInput.files[0]);

const resp = await fetch("https://api.skyconvert.net/v1/upload", {
  method: "POST",
  headers: { "X-API-Key": "YOUR_API_KEY" },
  body: form,
});
const { files } = await resp.json();
const filePath = files[0].file_path;

Response

{
  "ok": true,
  "files": [
    {
      "file_path": "a3f7bc91d8e2/image.png",
      "file_name": "image.png",
      "file_size": 204800,
      "upload_id": 42,
      "extension": "png"
    }
  ]
}

Upload a file and start a conversion job in one request. Returns a job_id; poll /v1/status/{job_id} to check progress.

Request (multipart/form-data)

* Either file or file_path is required.

curl -X POST https://api.skyconvert.net/v1/convert \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "file=@/path/to/input.png" \
  -F "filetype=image" \
  -F "output_format=webp"

import requests, time

API_KEY = "YOUR_API_KEY"
BASE    = "https://api.skyconvert.net/v1"

# 1. Start conversion
resp = requests.post(f"{BASE}/convert",
    headers={"X-API-Key": API_KEY},
    files={"file": open("input.png", "rb")},
    data={"filetype": "image", "output_format": "webp"},
)
job = resp.json()
job_id = job["job_id"]

# 2. Poll until done
while True:
    status = requests.get(f"{BASE}/status/{job_id}",
        headers={"X-API-Key": API_KEY}).json()
    if status["status"] == "finished":
        break
    if status["status"] == "failed":
        raise Exception(status.get("error"))
    time.sleep(2)

# 3. Download result
out = requests.get(f"{BASE}/download/{job_id}",
    headers={"X-API-Key": API_KEY})
with open("output.webp", "wb") as f:
    f.write(out.content)

const API_KEY = "YOUR_API_KEY";
const BASE    = "https://api.skyconvert.net/v1";

// 1. Start conversion
const form = new FormData();
form.append("file", fileInput.files[0]);
form.append("filetype", "image");
form.append("output_format", "webp");

const { job_id } = await fetch(`${BASE}/convert`, {
  method: "POST",
  headers: { "X-API-Key": API_KEY },
  body: form,
}).then(r => r.json());

// 2. Poll until done
let status;
do {
  await new Promise(r => setTimeout(r, 2000));
  status = await fetch(`${BASE}/status/${job_id}`,
    { headers: { "X-API-Key": API_KEY } }).then(r => r.json());
} while (status.status === "pending" || status.status === "processing");

// 3. Download result
if (status.status === "finished") {
  window.location.href = status.download_url;
}

Response (202 Accepted)

{
  "ok": true,
  "job_id": "a1b2c3d4-e5f6-...",
  "status": "pending",
  "status_url": "https://api.skyconvert.net/v1/status/a1b2c3d4-e5f6-...",
  "download_url": "https://api.skyconvert.net/v1/download/a1b2c3d4-e5f6-..."
}

Poll the status of a conversion job.

curl https://api.skyconvert.net/v1/status/JOB_ID \
  -H "X-API-Key: YOUR_API_KEY"

Response

// Pending / Processing
{ "ok": true, "job_id": "...", "status": "pending" }

// Finished
{ "ok": true, "job_id": "...", "status": "finished",
  "download_url": "https://api.skyconvert.net/v1/download/..." }

// Failed
{ "ok": false, "job_id": "...", "status": "failed",
  "error": "Unsupported codec" }

Download the converted file. Returns the raw file bytes with Content-Disposition: attachment. Only works once the job status is finished.

curl -O -J https://api.skyconvert.net/v1/download/JOB_ID \
  -H "X-API-Key: YOUR_API_KEY"

Inspect the current API key and check your remaining rate-limit quota.

curl https://api.skyconvert.net/v1/keys/me \
  -H "X-API-Key: YOUR_API_KEY"

Response

{
  "ok": true,
  "key_id": 3,
  "name": "My Production Key",
  "restriction_type": "ip",
  "allowed_ips": ["203.0.113.5"],
  "allowed_domains": [],
  "usage_count": 1042,
  "last_used_at": "2026-03-27T10:14:55",
  "created_at": "2026-01-01T00:00:00",
  "rate_limits": {
    "calls_per_day": 2000,
    "calls_per_minute": 60,
    "used_today": 412,
    "used_this_minute": 3,
    "remaining_today": 1588
  }
}