Skip to content

Quick start

Welcome to the StoryTeller documentation! We're excited to have you onboard. This Quick Start guide provides a short introduction. For detailed instructions and deeper insights, please refer to the pages linked below.

What is StoryTeller?

StoryTeller is an API-based SaaS product designed to generate personalized and engaging reports, focusing primarily on wealth portfolios and fund factsheets. It operates as an asynchronous, stateless service to generate these reports on-the-fly.

How does StoryTeller work?

  1. Account setup
    Before you can start using StoryTeller, an account needs to be set up for you. This is handled by InvestSuite and consists of configuring the report- and storage logic to your requirements. Once your account is active, you will receive an API key with which you can interact with our API.

  2. API call - asynchronous report generation
    With your account set up and API key in hand, you can make API calls to trigger the generation of reports. The report generation is asynchronous. A successful API call will return the name of the folder where the generated report will be stored, on the pre-configured storage server, once ready.

  3. Monitoring report storage
    After initiating the report generation, it's your responsibility to monitor your storage for the generated report. The report will be stored in the specified folder name returned by the API call. Let the system monitor this storage location and manage the reports as per your needs.

Client systemClient systemStoryTeller APIStoryTeller APIFinancial Data APIFinancial Data API(Optional) Updating financial dataupload custom financial dataGenerating reportsgather required portfolio information from internal systemscall API to generate a report(s)success message, folder ID(s)put report task(s) on queueMonitoring generated reportsloop[for each report task on queue]generate reportstore generated report on client storage, under corresponding folder ID from original API response

Making your API call

Once you have your API key, you can start integrating the StoryTeller solution into your own system. Visit the StoryTeller API page for guidance on how to construct your first API call.

Need assistance?

For any queries or support, please refer to this documentation, or contact our support team.