FastPix Developer Documentation

{
  "success": true,
  "data": {
    "uploadId": "beff5537-de85-42e1-a673-2a405cd94177",
    "trial": false,
    "status": "cancelled",
    "url": "https://storage.googleapis.com/uploads-fp-asia/338acdeb-29d4-438b-a40c-1d4105134462/26b1a17d-4b0b-44f8-96b8-cc33cabc962e?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=fp-prod@fastpix-vms.iam.gserviceaccount.com/20250716/auto/storage/goog4_request&X-Goog-Date=20250716T132746Z&X-Goog-Expires=14400&X-Goog-SignedHeaders=host;x-goog-resumable&X-Goog-Signature=4eb42c38711d915f2b6792edacc48ed79bde9f02f829a084dfe09830e6d0e5ec50f2f3157964ed7e32d44b02e3967bf2e0ffeb7ca9335d65ae15b3ac33c7cb40ec710939c4a12202b749bdb4e3f7af8aba2746b41a642130280a372e4615e9773cea98f231388c9fde385f96142ffa901a900949e305c7d5b4c82590c3493aaf60ac5424d4f112fbf4120b7891adf9a7e17968328cd1128fe7b6f55447d15b562624a8e7539824d10e808a729906ac6fe8b2f561424f3e0db14eecad6e21f4f18513519a975c2c50e8304a5a723723e32aa9ac659d9b9875a85f29f007d57bb69c49b5ff9099e5a9834db7199e73ca01cf0dd85cae599203d3180fa27cfdd08d&upload_id=ABgVH88kcXwWvPOlER2G4UvAnrdQw80h_nfjMqwL-jFe6wpLvfBifpBtlnvPtN2BQQTOWggTpKAQ6uGHIJLDp1LHo2g1eePyfjqNi3oRiwxOBU8",
    "timeout": 14400,
    "corsOrigin": "*",
    "maxResolution": "1080p",
    "accessPolicy": "public",
    "metadata": {
      "key1": "value1"
    }
  }
}

This endpoint allows you to cancel ongoing upload by its uploadId. Once cancelled, the upload is marked as cancelled. Use this if a user aborts an upload or if you want to programmatically stop an in-progress upload.

How it works

Make a PUT request to this endpoint, replacing {uploadId} with the unique upload ID received after starting the upload.
The response confirms the cancellation and provide the status of the upload.

Webhook Events

Once the upload is cancelled, you must receive the webhook event video.media.upload.cancelled.

Example

Suppose a user starts uploading a large video file but decides to cancel before completion. By calling this API, you can immediately stop the upload and free up resources.

This endpoint allows you to cancel ongoing upload by its `uploadId`. Once cancelled, the upload is marked as cancelled. Use this if a user aborts an upload or if you want to programmatically stop an in-progress upload. #### How it works 1. Make a PUT request to this endpoint, replacing `{uploadId}` with the unique upload ID received after starting the upload. 2. The response confirms the cancellation and provide the status of the upload. #### Webhook Events Once the upload is cancelled, you must receive the webhook event <a href="https://fastpix.com/docs/webhooks/media-events#videomediauploadcancelled">video.media.upload.cancelled</a>. #### Example Suppose a user starts uploading a large video file but decides to cancel before completion. By calling this API, you can immediately stop the upload and free up resources.

Authentication

AuthorizationBasic

FastPix APIs are secured with Basic Authentication. Use your Access Token ID as the username and Secret Key as the password in the Authorization header of each API request.

Username: Access Token ID
Password: Secret Key

Activate your FastPix account to generate your API credentials. See the guide here

FastPix APIs are secured with Basic Authentication. Use your Access Token ID as the username and Secret Key as the password in the Authorization header of each API request. - <b>Username:</b> Access Token ID - <b>Password:</b> Secret Key Activate your FastPix account to generate your API credentials. <a href="https://fastpix.com/docs/getting-started/activate-your-account" target="_blank">See the guide here</a>

Path parameters

uploadIdstringRequiredformat: "uuid"

When uploading the media, FastPix assigns a universally unique identifier with a maximum length of 255 characters.

Response

Upload cancelled successfully

successboolean

Demonstrates whether the request is successful or not.

dataobject

Response returned when an upload is cancelled.

How it works

Make a PUT request to this endpoint, replacing {uploadId} with the unique upload ID received after starting the upload.
The response confirms the cancellation and provide the status of the upload.

Webhook Events

Once the upload is cancelled, you must receive the webhook event video.media.upload.cancelled.

Example

Suppose a user starts uploading a large video file but decides to cancel before completion. By calling this API, you can immediately stop the upload and free up resources.

$	curl -X PUT https://api.fastpix.com/v1/on-demand/upload/4fa85f64-5717-4562-b3fc-2c963f66afa6/cancel \
>	-u "<username>:<password>"