Update a media by ID

PATCH

https://api.fastpix.com/v1/on-demand/:mediaId

PATCH

/v1/on-demand/:mediaId

curl -X PATCH https://api.fastpix.com/v1/on-demand/4fa85f64-5717-4562-b3fc-2c963f66afa6 \
     -H "Content-Type: application/json" \
     -u "<username>:<password>" \
     -d '{
  "metadata": {
    "user": "fastpix_admin"
  },
  "title": "test title",
  "creatorId": "8fa85f64-5717-4562-b3fc-2c963f66afa6"
}'

200Updated

{
  "success": true,
  "data": {
    "thumbnail": "https://images.fastpix.com/837f028b-dcaf-4c23-b368-3748641f74ac/thumbnail.png",
    "id": "cfeec1a3-6cbd-40df-a425-2ed7f8f72ced",
    "workspaceId": "6dc2b4e0-0615-42fd-a580-1f4aad932dfe",
    "metadata": {
      "user": "fastpix_admin"
    },
    "mediaQuality": "standard",
    "creatorId": "fastpix-123",
    "title": "Test-Video-Title",
    "maxResolution": "1080p",
    "sourceResolution": "1080p",
    "status": "Ready",
    "sourceAccess": false,
    "playbackIds": [
      {
        "id": "837f028b-dcaf-4c23-b368-3748641f74ac",
        "accessPolicy": "public",
        "accessRestrictions": {
          "domains": {
            "defaultPolicy": "allow",
            "allow": [],
            "deny": []
          },
          "userAgents": {
            "defaultPolicy": "allow",
            "allow": [],
            "deny": []
          }
        }
      }
    ],
    "tracks": [
      {
        "id": "f301a2a1-b40d-40fa-b419-4d0cd92a62f8",
        "type": "video",
        "width": 1920,
        "height": 1080,
        "frameRate": "30/1",
        "status": "available"
      }
    ],
    "generatedSubtitles": [],
    "isAudioOnly": false,
    "subtitleAvailable": true,
    "duration": 10.5,
    "aspectRatio": "16:9",
    "createdAt": "2025-01-09T06:44:44.617138Z",
    "updatedAt": "2025-01-09T06:44:53.742648Z"
  }
}

This endpoint allows you to update specific parameters of an existing media file. You can modify the key-value pairs of the metadata that were provided in the payload during the creation of media from a URL or when uploading the media directly from device.

How it works

Make a PATCH request to this endpoint. Replace <mediaId> with the unique ID (uploadId or id) of the media you received after uploading to FastPix
Include the updated parameters in the request body.
The response returns the updated media data, confirming the changes.
Monitor the video.media.updated webhook event to track the update status in your system.

Example

If a user uploads a video and later needs to change the title, add a new description, or update tags, you can use this endpoint to update the media metadata without re-uploading the entire video.

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

Path parameters

mediaIdstringRequiredformat: "uuid"

The unique identifier assigned to the media when created. The value must be a valid UUID.

Request

This endpoint expects an object.

metadatamap from strings to stringsOptional

titlestringOptional<=255 charactersDefaults to My Video Title

Title of the media file.

creatorIdstringOptional<=255 charactersDefaults to 8fa85f64-5717-4562-b3fc-2c963f66afa6

The unique identifier of the user who created this media.

Response

Media details updated successfully

successbooleanOptional

Demonstrates whether the request is successful or not.

dataobjectOptional