@encodeapi/cli

Command-line interface for EncodeAPI — create jobs, poll status, and estimate cost from your terminal.

Copyright 2026 EncodeAPI Australia

Install

npm install -g @encodeapi/cli

Or run without installing globally:

npx @encodeapi/cli jobs-create --input-url https://example.com/video.mp4

Setup

export ENCODEAPI_KEY=sk_test_your_key_here
# optional override:
export ENCODEAPI_BASE_URL=https://encodeapi.com/api/v1

Get API keys from encodeapi.com/dashboard/keys.

Examples

Create a sandbox encode job

encodeapi jobs-create \
  --input-url https://cdn.example.com/sample.mp4 \
  --profile mp4_1080p

Create an HLS ladder with webhook

encodeapi jobs-create \
  --input-url https://mybucket.s3.amazonaws.com/source.mp4 \
  --profile vod_hls \
  --webhook https://yourapp.com/webhooks/encode

Use a pipeline template (e.g. TikTok 9:16)

encodeapi jobs-create \
  --input-url https://example.com/video.mp4 \
  --template tiktok_9x16

Pin encode region

encodeapi jobs-create \
  --input-url https://example.com/video.mp4 \
  --profile mp4_1080p \
  --region eu-west

Ultrafast parallel encode (prepaid)

encodeapi jobs-create \
  --input-url https://example.com/video.mp4 \
  --profile mp4_1080p \
  --ultrafast

Get job status

encodeapi jobs-get cm123abc

Poll until complete

encodeapi jobs-wait cm123abc --timeout 3600 --interval 5

Estimate cost

encodeapi jobs-estimate \
  --input-url https://example.com/long-video.mp4 \
  --profile vod_hls

Batch create from JSON file

jobs.json:

{
  "jobs": [
    {
      "input": { "url": "https://a.mp4" },
      "pipeline": { "profile": "mp4_1080p" }
    },
    {
      "input": { "url": "https://b.mp4" },
      "pipeline": { "profile": "mp4_720p" }
    }
  ]
}

encodeapi jobs-batch jobs.json

List pipeline templates

encodeapi templates-list

Commands

| Command | Description | |---------|-------------| | jobs-create | Create an encoding job | | jobs-get <id> | Get job status and outputs | | jobs-wait <id> | Poll until completed, failed, or cancelled | | jobs-estimate | Price estimate without creating a job | | jobs-batch <file> | Create multiple jobs from JSON | | templates-list | List public pipeline templates |

Programmatic use

For Node.js applications, use the SDK instead:

npm install @encodeapi/sdk

See @encodeapi/sdk on npm.

License

MIT — Copyright 2026 EncodeAPI Australia