Contact Us Support Forum Get Email Updates
 
 

Thanks! Someone will be in touch with you shortly.

Rather just email us? Email us here.
Rather speak with someone in person?
Call any time with Experience API questions:

866.497.2676

xAPI Recipes

UNIVERSAL STOPFor xAPI to succeed, there needs to be shared agreement of how we talk about a specific type of experience. That’s what xAPI Recipes are for.

What is a xAPI Recipe?

A Recipe is a standard way of expressing a particular type of experience. It provides a common language and prevents the use of different words saying the same thing.

Example:
Suppose that YouTube and Vimeo both wanted to express that a person interacted with a video. Each one might talk about the same activities in very different ways:

vimeo
Vimeo might say:

Tim Martin watched “How to make Grilled Cheese
Tim Martin played the first 31 seconds of “How to Make Grilled Cheese
Tim Martin paused “How to Make Grilled Cheese” at 31 seconds
Tim Martin exited “How to make Grilled Cheese

Youtube
YouTube might say:

Tim Martin launched “How to Make Grilled Cheese
Tim Martin watched from 0s to 31s of “How to Make Grilled Cheese
Tim Martin paused “How to Make Grilled Cheese” at 31s
Tim Martin closed “How to Make Grilled Cheese

Same experiences, different statements. This makes reporting difficult. But, If both these systems used the video Recipe, their statements would look the same. Recipes allow different systems to talk about things people do using the same words.

Recipes tell you how.

Basically, a Recipe specifies which verbs and activity types and extensions and the like to use and how to use them for a given experience. No need to start from scratch. To read about the deep details about how a Recipe works, go here.

Recipes promote consistency.

For xAPI to succeed we need to create consistency for how statements are expressed. It makes life easier for authors of statements because they don’t have to blaze a trail and simplifies reporting for LRSs because they can expect more consistency of expression.

Any experience can have a Recipe…and some do.

Anything that is going to be expressed through xAPI by more than one system should have a Recipe. Right now, Recipes will be small and few. They will grow through subsequent versions as communities of practices become more prevalent.

We’ve compiled a summary of available recipes and expect this list to grow and grow!

Recipes are community driven. We need you.

Recipes aren’t going to happen independently—they need input from the community. Add requests for subsequent Recipes, comment on existing ones, and share Recipes you are working on.

Anyone can create a Recipe.

When you are ready to take the next step and create a Recipe, it’s easy to get started on the xAPI Registry, where the Recipes live.

If you want to read more about Recipes and why they are important, take a look at the resources below.

Recipe Resources:

Introductory Blog
Deep Dive Blog
Recipes Documentation (GitHub)

Available Recipes (in Registry)

Don't struggle!

We can help you find a suitable recipe or create one if it doesn’t exist.

Contact us


Experience API Email Updates

* indicates required

Experience API Email Updates

Thanks for signing up for the Experience API newsletter!

Make sure to follow us on Twitter @ProjectTinCan,
and tweet this page to let others know about the Experience API.

Close