DocumentationCreate Upload (Remote URL)

Create Upload (Remote URL)

Create a hosted asset from a video URL. Amplium fetches the video from your public http/https URL and starts HLS processing.

Endpoints

POST/api/videos/uploads

Create a new upload job from a remote URL.

Example 1: Without Encoding

Amplium fetches the video from your URL without encoding.

Request

curl -X POST "https://theamplium.com/api/videos/uploads" \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
    "name": "Demo AIV No Encode",
    "layout": "AIV",
    "videoUrl": "https://example.com/video.aivu",
    "isEncode": false,
    "isDrm": false
  }'

Response

{
  "status": "ok",
  "jobId": "0f6c1e5d-5f6a-4ef5-90b2-7a3b2e1e1111",
  "uploadId": null,
  "uploadStrategy": null,
  "partSizeBytes": null,
  "totalParts": null,
  "upload_status": {
    "percent": 0,
    "status": "Processing",
    "message": null
  },
  "name": "Demo AIV No Encode",
  "layout": "AIV",
  "isEncode": false,
  "isDrm": false
}

Example 2: With Encoding

Amplium fetches the video from your URL with encoding enabled.

Request

curl -X POST "https://theamplium.com/api/videos/uploads" \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
    "name": "Demo AIV",
    "layout": "AIV",
    "videoUrl": "https://example.com/video.aivu",
    "isEncode": true,
    "isDrm": false
  }'

Response

{
  "status": "ok",
  "jobId": "0f6c1e5d-5f6a-4ef5-90b2-7a3b2e1e1111",
  "uploadId": null,
  "uploadStrategy": null,
  "partSizeBytes": null,
  "totalParts": null,
  "upload_status": {
    "percent": 0,
    "status": "Processing",
    "message": null
  },
  "name": "Demo AIV",
  "layout": "AIV",
  "isEncode": true,
  "isDrm": false
}

Error Response

When an error occurs, the API returns a JSON response with this structure:

{
  "error": "BadRequest",
  "message": "isEncode must be true or false."
}

HTTP Error Codes

CodeError Type
400BadRequest
401Unauthorized
403Forbidden
404NotFound
413PayloadTooLarge
415UnsupportedMediaType
500InternalServerError

Request Parameters

ParameterTypeRequiredDescription
namestringRequiredThe video title.
layoutstringRequiredCurrently only AIV is supported.
videoUrlstringOptionalURL mode: http or https URL to video.
fileobjectOptionalDirect mode: { sizeBytes: number }.
isEncodebooleanOptionalDefault: false.
isDrmbooleanOptionalDefault: false.

Encoding Rules

AIV

  • isEncode false: packages the source directly; source must be 4320x4320.
  • isEncode true: re-encodes sources above 75 Mbps with software x265.