Authentication

Learn how to authenticate your API requests securely.

Flozium API uses API keys to authenticate requests. You can view and manage your API keys in the Dashboard > API Keys section.

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas.

Bearer Token

Authentication to the API is performed via HTTP Bearer Auth. Provide your API key as the basic auth username value.

Example Header

Authorization: Bearer mbp_live_xxxxxxxxxxxxx

Credit Usage (CRD)

Understanding how computational resources are billed.

Every processing job consumes Processing Credits (CRD) based on the source file size, target resolution, and optimization complexity. If your account balance drops below the required amount, the API will return a 402 Payment Required error.

Operation type	Base Cost
Standard Image Compression	1 CRD / file
HD Video Transcoding (1080p)	5 CRD / min
4K Video Upscaling	15 CRD / min

REST API Reference

Endpoints for managing media workflows.

Post /v1/jobs/transcode

Submits a new media file for batch processing. Processing credits will be deducted upon successful completion.

Example Request (cURL)

curl -X POST https://api.flozium.com/v1/jobs/transcode \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "source_url": "https://example.com/raw/video_01.mov",
    "output_format": "mp4",
    "resolution": "1080p",
    "webhook_url": "https://your-server.com/webhook"
  }'

Job Status

Poll the API to check rendering progress.

Get /v1/jobs/{job_id}

Retrieves the details and current status of an existing job.

Response (200 OK)

{
  "job_id": "job_9a8b7c6d5e",
  "status": "processing",
  "progress": 68,
  "estimated_time_remaining_sec": 134,
  "download_url": null
}

Webhook Events

Receive real-time notifications when your jobs complete.

Instead of polling the API, you can register a webhook endpoint. We will send an HTTP POST request to your server when a job transitions to completed or failed.

Event Payload (application/json)

{
  "event_type": "job.completed",
  "job_id": "job_9a8b7c6d5e",
  "cost": 15,
  "data": {
    "output_url": "https://storage.flozium.com/temp/v_01.mp4",
    "expires_at": "2024-10-22T10:00:00Z"
  }
}

Getting Started

Endpoints