Skip to content
Docs

Overview

Iomza API 1

Section titled “Iomza API 1”

Video transcoding: upload a video (or give its URL), create a job, and get adaptive streaming (HLS, DASH), MP4, MP3, posters and storyboards. JSON in and out, snake_case.

Authentication: Authorization: Bearer <api key>. Keys (iz_live_…) are created in the dashboard.

Errors always have the same shape, { "error": { "code", "message", "details" } }: branch on code, which is stable; message is English text for people and may change.

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “Operations”
POST
/v1/uploads
POST
/v1/uploads/{id}/parts
POST
/v1/uploads/{id}/complete
GET
/v1/uploads/{id}/tracks
POST
/v1/probe
GET
/v1/jobs
POST
/v1/jobs
GET
/v1/jobs/{id}
DELETE
/v1/jobs/{id}
POST
/v1/jobs/{id}/cancel
POST
/v1/jobs/{id}/retry
GET
/v1/live/usage
GET
/v1/live/channels
POST
/v1/live/channels
GET
/v1/live/channels/{id}
DELETE
/v1/live/channels/{id}
PATCH
/v1/live/channels/{id}
GET
/v1/live/channels/{id}/stream-key
POST
/v1/live/channels/{id}/rotate-key
POST
/v1/live/channels/{id}/stop
POST
/v1/live/channels/{id}/reactivate
GET
/v1/live/channels/{id}/sessions
DELETE
/v1/live/channels/{id}/sessions/{session_id}
GET
/v1/usage
GET
/v1/organization
GET
/v1/webhook-deliveries
GET
/v1/health
POST
The event job.processing WEBHOOK
POST
The event job.succeeded WEBHOOK
POST
The event job.failed WEBHOOK
POST
The event job.canceled WEBHOOK
POST
The event live.started WEBHOOK
POST
The event live.ended WEBHOOK
POST
The event live.balance_depleted WEBHOOK

Authentication

Section titled “Authentication”

apiKey

Section titled “apiKey”

An API key: iz_live_….

Security scheme type: http