Get a media by ID

GET

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

GET

/v1/on-demand/:mediaId

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

200Retrieved

{
  "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": {
      "key1": "value1"
    },
    "mediaQuality": "standard",
    "maxResolution": "1080p",
    "sourceResolution": "1080p",
    "status": "Ready",
    "mp4Support": [
      {
        "type": "capped_4k",
        "status": "ready",
        "height": 1080,
        "width": 1920,
        "ext": "mp4"
      },
      {
        "type": "audioOnly",
        "status": "ready",
        "ext": "m4a"
      }
    ],
    "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"
      }
    ],
    "isAudioOnly": false,
    "subtitleAvailable": true,
    "duration": 10.5,
    "aspectRatio": "16:9",
    "createdAt": "2025-01-09T06:44:44.617138Z",
    "updatedAt": "2025-01-09T06:44:53.742648Z"
  }
}

By calling this endpoint, you can retrieve detailed information about a specific media item, including its current status and a playbackId. This is particularly useful for retrieving specific media details when managing large content libraries.

How it works

Send a GET request to this endpoint. Use the <mediaId> you received after uploading the media file.
The response includes details about the media:
- status – Indicates whether the media is still Processing or has transitioned to Ready.
- playbackId – A unique identifier that allows you to stream the media once it is Ready.
  You can construct the stream URL as follows:
  https://stream.fastpix.com/<playbackId>.m3u8

Example

If your platform provides users with a dashboard to manage uploaded content, a user might want to check whether a video has finished processing and is ready for playback. You can use the media ID to retrieve the information from FastPix and display it in the user’s dashboard.

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.

Response

Get a video media by id

successbooleanOptional

Demonstrates whether the request is successful or not.

dataobjectOptional