Developer API docs

Integrate image conversion with your private API key.

Quick start

Endpoint: POST /api/v1/jobs

Status API: GET /api/jobs/:id

Authentication: x-api-key: img_xxx...

API usage requires a paid plan (Pro or Business API).

Recommended workflow

1) Submit conversion job
2) Poll status by id
3) Download when status=DONE

Language snippets

Download starter kit (.zip)

Includes README + ready-to-run examples.

curl.sh

#!/usr/bin/env bash
API_BASE="https://favicore.com"
API_KEY="img_xxxxxxxxx"
FILE_PATH="./sample.jpg"

CREATE_RESPONSE=$(curl -sS -X POST "$API_BASE/api/v1/jobs" \
  -H "x-api-key: $API_KEY" \
  -F "file=@$FILE_PATH" \
  -F "targetFormat=png")

echo "$CREATE_RESPONSE"
JOB_ID=$(echo "$CREATE_RESPONSE" | sed -n 's/.*"id":"\([^"]*\)".*/\1/p')
curl -sS "$API_BASE/api/jobs/$JOB_ID"

Expected response

{
  "id": "job_uuid",
  "status": "QUEUED",
  "targetFormat": "png"
}