Storyteller REST API

The Storyteller REST API allows you to query data in your Storyteller projects. The API is based on REST principles, making it easy to write and test applications. You can use your browser to access URIs, or you can use an HTTP client in any programming language to interact with the API.

System Requirements

Before you begin, ensure the following system requirements are met:

  • You must have an API license. To enable API access, please login to the Blueprint Community and submit a support case.
  • You must have a Storyteller username and password.

About REST (REpresentational State Transfer)

REST-style architectures consist of clients and servers:

  1. Clients initiate requests to servers
  2. Servers process requests and return appropriate responses

Requests and responses are built around the transfer of representations of resources. The client begins sending requests when it is ready to make the transition to a new state. While one or more requests are outstanding, the client is considered in transition.

The representation of each application state contains links that may be used the next time the client chooses to initiate a new state-transition.

Get started now with the Storyteller REST API using the Quick Start Example.