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

Extract a frame from a preview file movie. Frame number can be specified as query parameter, defaults to 0.

Path parameters

  • preview_file_id string(uuid) Required

    Preview file unique identifier

Query parameters

  • frame_number integer

    Frame number to extract

Responses

  • 200 image/png

    Extracted frame as PNG image
GET /actions/preview-files/{preview_file_id}/extract-frame 
curl -X GET "http://api.example.com/actions/preview-files/a24a6ea4-ce75-4665-a070-57453082c25/extract-frame?frame_number=120" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"
import requests

url = "http://api.example.com/actions/preview-files/a24a6ea4-ce75-4665-a070-57453082c25/extract-frame"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Accept": "application/json"
}
params = {
    "frame_number": 120
}
payload = None

response = requests.get(
    url,
    headers=headers,
    params=params,
    json=payload
)

response.raise_for_status()

if response.content:
    print(response.json())
curl \
 --request GET 'http://api.example.com/actions/preview-files/a24a6ea4-ce75-4665-a070-57453082c25/extract-frame' \
 --header "Authorization: $API_KEY"