Get scene analysis | FastPix Developer Documentation

{
  "success": true,
  "data": {
    "status": "COMPLETED",
    "result": {
      "scenes": [
        {
          "startTime": 0,
          "endTime": 1.478,
          "description": "A computer screen displaying a chat application with a list of steps for modifying the application."
        },
        {
          "startTime": 1.478,
          "endTime": 3.44,
          "description": "A woman in a blue dress is seated, smiling and speaking. The background includes modern wall decor."
        },
        {
          "startTime": 3.44,
          "endTime": 8.12,
          "description": "Close-up of fingers typing lines of Java code on a mechanical keyboard with RGB backlighting."
        }
      ]
    }
  }
}

This endpoint retrieves the AI-generated scene analysis for an existing media. The response includes timestamped scenes and their visual descriptions, which can be used for content discovery, navigation, indexing, or review workflows.

How it works

Send a GET request to this endpoint, replacing <mediaId> with the ID of the media.
The response includes the job status and the generated scene analysis.

Use case: Use this endpoint to retrieve scene analysis for a video or other processed media.

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 it is created. The value must be a valid UUID.

Response

Successfully retrieved media scene analysis.

successbooleanOptional

Shows the request status. Returns true for success and false for failure.

dataobjectOptional