Developer docs

Ship video.
Skip the pipeline.

One API for direct uploads or videos already in your cloud storage (S3, GCS, Azure, Quat), plus background processing and protected playback.

OPERATIONAL
01IngestResumable
02ProcessFFmpeg · HLS
03DeliverSigned playback
BUILT FOR YOUR APP
01Resumable
ingestion
02Adaptive
HLS output
03Protected
playback
04Usage-based
billing

01 / VEXOR API

Quickstart

Start with a server-side API key. Upload a video or import one from connected storage, wait for it to become ready, then issue a playback token.

  1. 01 / AUTHENTICATEStore your API key in a backend environment variable.
  2. 02 / UPLOADCreate a resumable upload using the Tus protocol.
  3. 03 / PLAYIssue an asset-scoped token after processing completes.
Create an upload · cURL
bash
curl -i -X POST "$VEXOR_API_URL/uploads" \
  -H "Authorization: Bearer $VEXOR_API_KEY" \
  -H "Tus-Resumable: 1.0.0" \
  -H "Upload-Length: $FILE_SIZE_BYTES" \
  -H "Upload-Metadata: filename bGVzc29uLm1wNA==,filetype dmlkZW8vbXA0"

# Use the Location response header as the upload URL.
# PATCH it with Upload-Offset and application/offset+octet-stream.

Metadata values use Base64 as required by Tus. The example encodes lesson.mp4 and video/mp4. Vexor assigns account ownership from authentication; do not send an account ID in upload metadata.

02 / VEXOR API

Authentication

Send your developer API key as a Bearer token when calling protected API routes.

Authenticated API request
bash
curl "$VEXOR_API_URL/v1/assets" \
  -H "Authorization: Bearer $VEXOR_API_KEY"

Keep the key private. Call Vexor from your backend. Do not include your API key in browser bundles, public repositories, or mobile app builds. Return only the scoped playback data your client needs.

Create an account to get an API key

03 / VEXOR API

Direct & resumable uploads

Use parallel browser-to-storage multipart uploads when enabled. Tus 1.0 remains available for resumable byte-range uploads.

Direct multipart is opt-in and requires the configured RAW_S3 bucket to allow your portal origin, PUT, and the signed request headers in its CORS policy. Vexor returns temporary part URLs; keep storage credentials on the server.
RequestPurpose
POST /v1/uploads/directCreate an account-owned session with filename, mime_type, and file_size; Vexor returns the part size and follow-up URLs.
POST {upload_url}Request temporary signed PUT URLs for up to 100 part numbers, then upload those file slices directly to storage.
GET {status_url}List accepted parts after a disconnect; upload only missing or incomplete parts.
POST {complete_url}Ask Vexor to verify and assemble all parts and queue transcoding.
POST /uploadsCreate an upload. Include Tus-Resumable, Upload-Length, and optional Upload-Metadata headers.
HEAD {upload_url}Read Upload-Offset before resuming an interrupted transfer.
PATCH {upload_url}Include Tus-Resumable, Upload-Offset, and application/offset+octet-stream; send the next byte range.

Incomplete uploads expire after the configured retention window. Respect the offset returned by the server; it is the source of truth when resuming.

Already have a storage bucket?

Import the video from where it lives

Connect a cloud storage source in Console → Settings → Storage, then submit its connection and object path. This works with AWS S3, Google Cloud Storage, Azure Blob Storage, Quat, Cloudflare R2, and MinIO endpoints. VEXOR leaves your original in place and stores processed HLS in VEXOR-managed storage.

Import a source object · cURL
bash
curl -X POST "$VEXOR_API_URL/v1/assets/imports" \
  -H "Authorization: Bearer $VEXOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"connection_id":"YOUR_CONNECTION_ID","object_key":"courses/lesson-01.mp4"}'

# Returns 202 Accepted. Poll GET /v1/assets/{id} for processing status.

04 / VEXOR API

Assets & processing

Upload completion queues processing in the background. Poll an asset for detail or use webhooks to react without polling.

Read asset status
bash
curl "$VEXOR_API_URL/v1/assets/YOUR_ASSET_ID" \
  -H "Authorization: Bearer $VEXOR_API_KEY"
uploading →uploaded→transcoding→readyFAILED CAN OCCUR DURING PROCESSING

Ready assets include the playback manifest and generated metadata. Failed jobs expose an error state so your app can show a useful message.

05 / VEXOR API

Secure playback

Request playback authorization from your backend after the asset reaches ready. Vexor returns a short-lived token and a manifest URL.

Issue a playback token
bash
curl -X POST "$VEXOR_API_URL/v1/tokens" \
  -H "Authorization: Bearer $VEXOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"asset_id":"YOUR_ASSET_ID","viewer_id":"viewer_123","session_id":"session_456"}'

# Response includes: token, manifest_url, and thumbnail_url when available.

Tokens are bound to the requested asset and expire after five minutes. Pass the returned manifest_url to an HLS-compatible player. Never expose the Vexor API key to the viewer.

Playback keys stay behind Vexor.

Vexor encrypts HLS segments with AES-128 CBC. Its playback key service checks the short-lived, asset-scoped token before returning the decryption key. This is HLS encryption and access control, not platform DRM.

06 / VEXOR API

SDKs & plugins

Start from an integration source that matches your stack. Keep the Vexor API key on a trusted server and return only scoped playback data to clients.

01 / INTEGRATIONNode.js

Node.js / TS SDK

Server uploads, S3 imports, playback tokens, and signed webhook verification.

npm package
$ npm i @vexor-video/sdk
const vexor = new Vexor();
Read integration guide
02 / INTEGRATIONPython

Python SDK

Server uploads, asset status, playback token authorization, and webhook verification.

pypi package
$ pip install vexor-video-sdk
client = Vexor()
Read integration guide
03 / INTEGRATIONReact

React Player

Adaptive HLS playback, accessible controls, dynamic watermark, and token auto-refresh.

react component
$ npm i @vexor-video/player
<VexorPlayer src={url} />
Read integration guide
04 / INTEGRATIONWordPress

WordPress Plugin

Connect your Vexor account in wp-admin, pick an asset, and embed it in posts or lessons.

wp shortcode
<!-- WordPress Lesson -->
[vexor_player id="..."]
Read integration guide
05 / INTEGRATIONGitHub Action

GitHub Action

Automate video transcoding, cloud storage imports, and PR player previews in CI/CD.

ci/cd action
name: Transcode Video
uses: vexor/action@v1
Read integration guide

Node.js / TypeScript

Use @vexor-video/sdk for resumable uploads, storage imports, asset operations, playback tokens, and webhook signature verification.

Python

Use the server SDK for upload orchestration, asset operations, and webhook signature verification.

React

Render the player with a server-issued playback token; provide a refresh callback for long sessions.

WordPress

Save the API key in wp-admin. The plugin obtains viewer-specific tokens through a same-origin server request.

Install the Node.js / TypeScript SDK with npm install @vexor-video/sdk. The Python, React Player, and WordPress integrations are available from the Vexor repository.

07 / VEXOR API

GitHub Actions CI/CD

Automate video transcoding, cloud storage imports, and interactive PR video preview comments directly from your GitHub workflows.

Official GitHub Action · vexor-video/action@v1

Zero external runtime dependencies. Runs on standard Node 20+ runners with automatic secret masking, direct multipart uploads or cloud storage imports, wait-for-transcode polling, and pull-request preview bot comments.

.github/workflows/preview-video.yml
yaml
name: Video Ingest & PR Preview
on:
  pull_request:
    paths: ['assets/**.mp4', 'demos/**']

jobs:
  transcode:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      pull-requests: write
    steps:
      - uses: actions/checkout@v4
      - name: Ingest to Vexor
        id: vexor
        uses: vexor-video/action@v1
        with:
          api_key: ${{ secrets.VEXOR_API_KEY }}
          file_path: 'demos/feature-walkthrough.mp4'
          title: 'PR Preview · ${{ github.head_ref }}'
          wait_for_ready: 'true'
          comment_on_pr: 'true'
          github_token: ${{ secrets.GITHUB_TOKEN }}

      - name: Report Stream URL
        run: echo "Stream URL is ${{ steps.vexor.outputs.playback_url }}"

DIRECT UPLOAD

Specify file_path to chunk and stream files from runner storage.

STORAGE IMPORT

Pass connection_id and object_key for zero-bandwidth cloud ingest.

SECRET MASKING

API keys are registered with runner maskers to guarantee credentials never leak to build logs.

08 / VEXOR API

Webhooks

Subscribe to upload and asset-ready events from your application. Vexor signs each raw JSON request with HMAC-SHA256.

video.upload.completed

The resumable upload finished and the source is staged for processing.

video.asset.ready

The master HLS manifest is available for playback.

Verify, persist, acknowledge.

Compute the HMAC over the exact raw request body and compare it with X-Vexor-Signature using a timing-safe comparison. Store X-Vexor-Event-ID with a unique constraint so retries do not repeat side effects. Return a 2xx after durable acceptance.

HEADERS · X-VEXOR-SIGNATURE · X-VEXOR-EVENT-ID · X-VEXOR-TIMESTAMP

Explore the developer overview

09 / VEXOR API

Billing

Use one prepaid VEXOR balance for video infrastructure. Each account uses one wallet currency: ETB for Telebirr or USD for card payments, with every top-up and usage charge recorded in the ledger.

Processing & MP4 exports

$0.50 or 3 ETB per video minute, prorated by duration. Successful MP4 exports use the same processing rate.

Resolution upgrades

One-time per-asset surcharges: 1080p +$1 / 50 ETB, 1440p +$3 / 100 ETB, 4K +$8 / 150 ETB, 8K +$20 / 200 ETB.

Storage & delivery

Processed media in VEXOR storage: $0.03 or 500 ETB per GB-month. USD delivery: $0.15 per reported GB, reconciled monthly after verified edge reports arrive.

Add balance

Telebirr adds ETB to ETB wallets. Card packs add USD credit to USD wallets. Each account uses one currency; balances are not converted or combined.

TELEBIRR · CUSTOM ETB TOP-UP

Card packs

$10

$10 USD

$50

$52 USD

+4% CREDIT

$200

$224 USD

+12% CREDIT

Amounts are stored as integer minor units and tagged with the wallet currency. Card credit is applied only after verified payment confirmation. The original object in connected customer storage remains customer-billed; VEXOR charges for processed media retained in VEXOR-managed storage. Delivery billing needs a trusted edge reporter to send signed byte totals before invoices can include delivery usage.