Introduction

Welcome to the Reframe API documentation. Reframe provides a suite of core APIs that allow developers to tap into Reframe's powerful services to create engaging and highly personalized content.

Authentication

All requests to Reframe APIs need to include an API key in the X-API-Key header.

Request an API key here: https://www.reframeapi.com/about

Reframe Personalization Engine

Reframe Personalization Engine empowers you to unlock vast potential from your customer data, irrespective of the source system. Reframe Personalization Engine is designed to seamlessly ingest data, and in return, yield richly detailed, engaging, and highly personalized video output.

API Parameters

curl -H 'X-API-Key: <your-api-key>' \
  --json @my-template.rvs \
  'https://rpe.endpoint.reframeapi.com/latest?first_name=Bob&favourite_drink=latte'

import reframeapi

# The customer data can be sourced from any system
customer_data = {'first_name': 'Bob', 'favourite_drink': 'latte'}

# Replace with your API key
r = reframeapi.client(api_key='<your-api-key>')

# This assumes that your VisionScript template is saved in my-template.rvs
with open('./my-template.rvs', 'r') as f:
  return_code, output = r.personalize(template=f.read(), variables=customer_data)

if return_code == 0:
  # Success
  print(f'Personalized video can be downloaded from: {output.url}')
else:
  print(f'Error calling Reframe Personalization Engine: {return_code}')

The API endpoint for Reframe Personalization Engine is: https://rpe.endpoint.reframeapi.com/latest

Pricing

Reframe CourseDynamics

This platform provides educators, coaches, and course authors with an intuitive, dynamic toolset to design online courses that are not only personalized to each student but also easy to update.

API Parameters

curl -H 'X-API-Key: <your-api-key>' \
  --json @my-template.rvs \
  'https://rcd.endpoint.reframeapi.com/latest?first_name=Bob'

import reframeapi

# The student data can be sourced from any system
student_data = {'first_name': 'Bob'}

# Replace with your API key
r = reframeapi.client(api_key='<your-api-key>')

# This assumes that your VisionScript template is saved in my-course.rvs
with open('./my-course.rvs', 'r') as f:
  return_code, output = r.coursedynamics(template=f.read(), variables=student_data)

if return_code == 0:
  # Success
  print(f'Personalized course video can be downloaded from: {output.url}')
else:
  print(f'Error calling Reframe Personalization Engine: {return_code}')

The API endpoint for Reframe CourseDynamics is: https://rcd.endpoint.reframeapi.com/latest

Pricing

Reframe VisionScript

Introducing Reframe VisionScript, a groundbreaking scripting language that paves the way for dynamic, highly personalized video experiences.

Designed for developers and accessible to non-technical users alike, VisionScript incorporates the robust features of modern scripting languages while ensuring simplicity in usage. It's an empowering tool that enables you to harness the complete suite of Reframe's API capabilities, seamlessly blending power and ease of use.

With VisionScript, transforming your visions into reality has never been more attainable, regardless of your technical proficiency. Dive into the world of VisionScript and redefine your video creation journey.

Reference

The basic VisionScript syntax is YAML-compatible.

Modules

Slideshow

slideshow:
  - body: |
      ## Slide One
      - Bullet One
      - Bullet Two
    voiceover: |
      This is slide one.

  - body: |
      ## Slide Two
      - Bullet Three
      - Bullet Four
    voiceover: |
      This is slide two.

This module calls the Slideshow API to generate a slideshow, with optional voiceover speech via Voice Synthetics.

AI Avatar

aiavatar: Hi there. Welcome to my training course.

This module calls the AI Avatar API to generate a talking avatar.

Webcast

webcast:
  steps:
    - goto: https://www.reframeapi.com
      voiceover: First, navigate to the Reframe website at www.reframeapi.com

    - click:
        locator:
          label: 'Get Started'
      voiceover: Then click on the Get Started button

This module calls the Webcast API to generate a recording of a web browser session.

Step reference

Reframe Core APIs

Reframe Webcast

Reframe Webcast API allows developers to generate recordings of web browser sessions.

Pricing

Reframe Slideshow

Reframe Slideshow API allows developers to generate dynamic slideshow videos from content written in Markdown.

Pricing

Reframe AI Avatar

Reframe AI Avatar API allows developers to generate virtual avatar animations from any written text.

Pricing

Reframe Voice Synthetics

Reframe Voice Synthetics API allows developers to generate text-to-speech audio with high-quality audio effects.

Reframe Elements

Reframe Elements API allows developers to store, personalize and consume source material that is either user or AI generated.

Reframe LiveStream

Reframe Captivate

Reframe AudioBoard

Reframe DataFlow

Reframe Translate

Rate Limiting

Errors

The Reframe API uses the following error codes: