Prime Video Avails API - Prime Video Tech Docs

Prime Video Avails API

Last updated 2024-09-30

The Prime Video Avails API enables partners to efficiently manage the availability of their titles on Prime Video by programmatically submitting, updating, retrieving, or deleting availability windows. In contrast to the traditional Avail file upload process, the API offers more accurate licensing information, enhanced control over content availability, and automated workflows, improving partners’ overall operational efficiency.

Designed to streamline integration between partner content rights management systems and Prime Video, the Avails API supports four key operations:

  • Create/Update Avail: Add or update availability for a title.
  • Get Avails: Retrieve availability information for a title.
  • Delete Avails: Remove existing availabilities for a title.
  • Validate Avail: Perform validation checks on submitted availability data.

Benefits of the Avails API for partners

Partners can leverage the following benefits to enhance their overall content management capabilities, reduce operational bottlenecks, and maintain greater control over the availability of their titles on Prime Video.

  • Automated management: The Avails API automates the entire process of submitting and updating availability windows for titles, significantly reducing manual labor. The API removes the need for manual uploads and human intervention, which minimizes the likelihood of errors, and ensures greater accuracy in content availability management. This automation allows partners to focus on higher-level tasks, to improve operational productivity and streamline the workflow.
  • Increased efficiency: The API allows partners to retrieve or modify specific availability windows without having to resubmit the entire set of content availability data. This selective update capability reduces the workload and saves time, especially when only small changes are required. It eliminates the redundancy of uploading the same information repeatedly, optimizing the management of availability windows and reducing processing time.
  • Direct feedback: One of the key advantages of the Avails API is its ability to validate submitted data in real time. The API performs automatic checks on the availability information and immediately returns error messages if any issues or inconsistencies are detected. This direct feedback eliminates the need for partners to log into Slate for error checking and manual corrections, resulting in faster troubleshooting and improved data accuracy.
  • Flexible integration: The Avails API is designed with flexibility in mind, offering support for both Full Extract and Partial Extract models. The Full Extract model requires you to submit all availability windows at once for a given title, territory, and business line, while the Partial Extract model allows incremental updates by focusing on specific availability windows. This flexibility enables partners to choose the model that best fits their operational needs and workflows, whether they are handling large-scale updates or making minor adjustments to availability data.
  • Interoperability: The API is built on a REST interface, making it language, system, and platform-agnostic. It can be accessed by any system with an internet connection.

Extract models supported

The Avails API supports several extract models for managing availability windows:

  • Full Extract model
    • Requires partners to submit all availability windows for a specific scope in one request.
    • Scope: Title + Territory + Business Line.
    • This model is the default for all partners and ensures that the full context of availability data is updated together.
  • Partial Extract model
    • Allows updates to individual availability windows using a unique identifier (EMA AvailID, aka MDDF TransactionID).
    • Enables incremental updates, meaning only the availability window that has changed needs to be submitted.
    • Because the Prime Video supply chain originally supported only the Full Extract model, partners willing to move from the Full Extract model to the Partial Extract model must submit AvailID/TransactionID using the Full Extract model. Once all availability windows have unique identifiers, partners may begin to use the Partial Extract model.
  • Mixed model
    The Prime Video supply chain allows partners to use any model in API calls. This means that for every API call, a partner can choose to use any model they want. One pre-requisite for using a Mixed model is for partners to be onboarded to a Partial Extract model, as described above.

Links

For more information about how to work with the Avails API in Slate, check out the following topics:

Can’t find what you’re looking for?

Contact us


Internal Server error! Please try again
Your session has expired

Please sign in to continue

Sign In
edit