Web Stories API Reference - Web Stories Today

Web Stories API Reference

The Web Stories API lets you incorporate functions normally executed on the Web Stories website into your own website or application. The lists below identify the different types of resources that you can retrieve using the API.

This reference guide explains how to use the API to perform all of these operations.

CALLING THE API

  1. Every request must specify an API key, Your API Key is available in the Developer Console, accessible via your Dashboard
    The API Key is free

RESOURCES TYPES

StoryCategory

A StoryCategory resource containes information on a particuar category, including display name and the encoded version. A Storycategory resource contains information on a particuar category, including display name and the encoded version.

{
    "displayname": "Fashion for Her",
    "displayname_encoded": "fashion-for-here"
}

ChannelInfo

A ChannelInfo resource containes information on a particuar channel/creator, including display name, url, description, logo, number of stories,...

{
    "name": "The Scotsman",
    "uid": "TheScotsman",
    "description": "Subscribe to The Scotsman for news, opinion and expert analysis from Scotland\u2019s national newspaper",
    "url": "https://webstories.today/@thescotsman",
    "logo": "https://webstories.today/images/channels/73d7af4b-6ee7-4c6d-b3c8-8ecc2ada095b-logo.jpg"
}
            

WebStory

A WebStory resource contains information on a particular story, including display name, url, description, images, channelinfo, category,....

 {
    "title": "Guide to puppy potty training",
    "url": "guide-to-potty-training-within-7-days",
    "language": "en",
    "description": "How to get your puppy potty trained quickly. The story contains easy and actionable steps. ",
    "channelinfo": {
    "name": "The Happy Puppers",
    "uid": "The-happy-puppers",
    "description": "Hi I\u0027m Dr. Shruti, and I love writing on everything related to dog care, so Welcome to your one-stop destination of dog care. Articles focus on dog care tips, grooming, psychology, training, diseases, and everything dog-related...",
    "url": "https://webstories.today/@the-happy-puppers",
    "logo": "https://webstories.today/images/channels/64790bff-a8d0-43be-b7a3-36a08bc0ff92-logo.jpg"
    },
    "category": {
    "displayname": "",
    "displayname_encoded": ""
}