Skip to content

Previews API Changelog

2025-10-03

  • Improved character selection Replaced the character parameter with character_preference and character_list.

character_preference can be set to:

  • None: no character requirement. character_list should be empty.
  • any: at least one character must be included. character_list should be empty.
  • avoid: no characters should be included. character_list should be empty.
  • any_of: at least one character from character_list must be included.
  • all_of: all the characters in character_list must be included.

The character parameter continues to function but is deprecated from now on.

2025-05-19

  • Improved ranking algorithm for previews. Top results should be more relevant to the title while maintaining diversity in the subsequent results. This improvement is only available for customers on model version >= 17.

2025-02-24

Updates

  • Released the /v2 version of the API.

The /v1 version of the API is deprecated but remains active. The new /v2 version of the API is now available and should be used for all new integrations.

The new /v2 version of the API features:

  • The processing status is now returned in the response.
  • A new endpoint (/) is available. It allows retrieving the bulk processing status for multiple assets.

Migration guide

  • The response of the /{inventory_id} endpoint contains the data in the old format in the data field.
  • The number_of_top_clips (/{inventory_id}) was renamed to number_of_top_candidates
  • The clip_type parameter (/{inventory_id}) doesn't support deprecated clip types anymore.

2025-01-20

Updates

  • Improved ranking algorithm for previews. Top results should be more diverse, while still relevant in the context of the title.

2024-12-19

Updates

  • Improved ranking for clips (only available for customers on model version >= 17).
  • New clip types have been introduced alongside the previous ones:
  • Funny and comical
  • High-octane action
  • Heartfelt
  • Epic scenery
  • Creepy and scary

2024-11-19

Updates

  • Relevance scores in the output are normalized to be in the range of 0–1.

2024-10-29

Updates

  • The API endpoint now adds keywords to each generated clip (only for customers on model >= 17). This means that each preview we produce will have the following new fields:
  • environment - keywords describing the environment, location or surroundings of the preview.
  • keywords - keywords describing actions, objects or other descriptive words that try to describe the content of the preview
  • mood - more abstract keywords describing the mood or atmosphere of the clip.