GET /actions/preview-files/{preview_file_id}/extract-annotated-frame
Jwt authorization

Extract a frame from a movie preview, or the picture itself from a picture preview, and overlay the matching annotation on it. frame_number is required for movies and ignored for pictures. Returns 400 if no annotation is recorded.

Path parameters

  • preview_file_id string(uuid) Required

    Preview file unique identifier

Query parameters

  • frame_number integer

    Frame number to extract (movies only, 1-based)

    Minimum value is 1.

Responses

  • 200 image/png

    Composited frame as PNG image
  • 400

    No annotation, missing frame_number on movie, or unsupported extension

  • 404

    Preview file binary is not available

GET /actions/preview-files/{preview_file_id}/extract-annotated-frame 
curl \
 --request GET 'http://api.example.com/actions/preview-files/a24a6ea4-ce75-4665-a070-57453082c25/extract-annotated-frame' \
 --header "Authorization: $API_KEY"