Get the summary of a video | FastPix Developer Documentation

curl https://api.fastpix.com/v1/on-demand/fc733e3f-2fba-4c3d-9388-2511dc50d15f/summary \
     -u "<username>:<password>"

{
  "success": true,
  "data": "Grandmaster Igor Spirinov introduces the Kutch Gambit, an effective chess opening for players rated below 1500. He emphasizes quick development and pressure on the opponent, particularly targeting the f7 pawn. The gambit forces opponents to play precisely, as common moves can lead to quick defeats. Spirinov outlines various responses from Black, highlighting tactical opportunities for White, including sacrifices and double checks that can lead to checkmate. He also discusses strategies for handling more experienced opponents and emphasizes the importance of maintaining a strong position and advancing pawns in the middle game. A special training bundle is offered for players seeking improvement."
}

This endpoint returns the generated summary of a video. The summary is created using the **InVideo Summary** feature, which processes the video content and produces a textual summary. To use this endpoint, you must first generate the video summary using the Generate Video Summary endpoint. This endpoint can return the summary only after that process is complete. Typical use cases include: - Providing viewers with a quick preview of the video's main content. - Enabling search or recommendation systems to surface summarized insights. - Supporting accessibility and content discovery without requiring users to watch the full video. If the summary has not been generated or the feature is disabled for the requested media, the endpoint returns an error indicating that the summary is unavailable.

curl https://api.fastpix.com/v1/on-demand/fc733e3f-2fba-4c3d-9388-2511dc50d15f/summary \
     -u "<username>:<password>"

{
  "success": true,
  "data": "Grandmaster Igor Spirinov introduces the Kutch Gambit, an effective chess opening for players rated below 1500. He emphasizes quick development and pressure on the opponent, particularly targeting the f7 pawn. The gambit forces opponents to play precisely, as common moves can lead to quick defeats. Spirinov outlines various responses from Black, highlighting tactical opportunities for White, including sacrifices and double checks that can lead to checkmate. He also discusses strategies for handling more experienced opponents and emphasizes the importance of maintaining a strong position and advancing pawns in the middle game. A special training bundle is offered for players seeking improvement."
}

This endpoint returns the generated summary of a video.

The summary is created using the InVideo Summary feature, which processes the video content and produces a textual summary.

To use this endpoint, you must first generate the video summary using the Generate Video Summary endpoint. This endpoint can return the summary only after that process is complete.

Typical use cases include:

Providing viewers with a quick preview of the video’s main content.
Enabling search or recommendation systems to surface summarized insights.
Supporting accessibility and content discovery without requiring users to watch the full video.

If the summary has not been generated or the feature is disabled for the requested media, the endpoint returns an error indicating that the summary is unavailable.

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 media summary

successboolean

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

datastring

The summary of the particular video.

$	curl https://api.fastpix.com/v1/on-demand/fc733e3f-2fba-4c3d-9388-2511dc50d15f/summary \
>	-u "<username>:<password>"

1	{
2	"success": true,
3	"data": "Grandmaster Igor Spirinov introduces the Kutch Gambit, an effective chess opening for players rated below 1500. He emphasizes quick development and pressure on the opponent, particularly targeting the f7 pawn. The gambit forces opponents to play precisely, as common moves can lead to quick defeats. Spirinov outlines various responses from Black, highlighting tactical opportunities for White, including sacrifices and double checks that can lead to checkmate. He also discusses strategies for handling more experienced opponents and emphasizes the importance of maintaining a strong position and advancing pawns in the middle game. A special training bundle is offered for players seeking improvement."
4	}