Run in Postman

Safe Stream API Documentation

Welcome to the Safe Stream API, helping you to warn your customers about mature and upsetting content present in TV shows and movies, before they click play.

Overview

The Safe Stream provides a API to create access tokens, search for content, add content tagged preferences and lookup the content rating and comments for a single piece of content.

It provides a powerful feature for services to manage and anonymously store the content preferences of their customers, content consumers. A consumer may set their individual preferences which is backed by our tagging system.

Our tagging system covers sensitivities over these items:

  • Nudity
  • Violence
  • Bad Language
  • Sexual Assault (implied or explicit)
  • Abuse
  • Substance Abuse
  • Drugs
  • Racism

When combined with the Instant Recommendation feature an individual consumer can know whether an single piece of content is suitable for them.

This dashboard provides 3 sections, information about your requests and remaining requests for a month, basic consumer statistics and global information of all content that is available to request.

Basic Dashboard

This next screen shows the API requests that have been made for a given account, all requests can be exported as a PDF or CSV file.

Request Breakdown

API Route

All requests use the below base API route, we anticipate the need for versioning in the future for more complex needs and reverse compatibility.

app.safestream.info/api/v1/

To start using the API follow these steps:

  1. Register an account from the portal.
  2. Generate a bearer token using your email and password.
  3. Search for content by name.
  4. Lookup for individual content guidance for the rating and comments.
  5. Manage Consumers for storing your consumers and sensitivity preferences toward content.
  6. Consumer Instant Recommendations after a consumer has been setup with preferences get a recommendation without details.

Finally look at the implementation recommendations for insight into displaying the comments for your consumers.

Features

Below are a list of the current features, for the initial version of the API, all of which are accessible for free users.

Basic Authorisation and OAuth token generation Dashboard for tracking requests with insight to global stats Wildcard search by name, content type or year Individual content lookup, the rating and comments for each different category Consumer management and sensitivity tracking Instant consumer recommendations without detailed comments

Additional items in our roadmap

These items will be added to our API and all registered users will be notified when they are ready.

Team management JS & PHP client SDKs Demo projects including React, React Native and Laravel.

Credits

The Safe Stream project has been created by Matthew Smithies founder of Happy Titan and lead developer for Coursematch.

Happy Titan is a full stack technical consultancy focused on helping startups rapidly build and maintain digital products, our internal products include Envboard.