Skip to navigation
IN-VIDEO AI APIScene analysis

Generate AI scene analysis

This endpoint analyzes an existing media and divides it into distinct visual scenes. Each scene includes start and end timestamps with an AI-generated description, making it easier to understand, search, and navigate the video’s visual content.

How it works

  1. Send a POST request to this endpoint, replacing <mediaId> with the ID of the media for which you want to generate scene analysis.
  2. The response confirms that the request was successful and returns the ID of the media. The job starts immediately after a successful request.
  3. You can use the video.media.ai.scene_analysis.ready webhook event to track and notify the status.
  4. After the webhook event is received, you can use the Get scene analysis endpoint to retrieve the generated scene analysis.

Use case: Use this feature to generate visual scene analysis for media that has already been uploaded, without requiring the user to upload it again.

Related guide: Scene analysis

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 triggered scene analysis generation.
successbooleanOptional
Shows the request status. Returns true for success and false for failure.
dataobjectOptional