Storyteller Integration API#
Welcome to the Storyteller Integration API documentation. The Integration API allows developers to send content to Storyteller so that it can be edited and distributed within your Storyteller ecosystem. This enables you to use your existing tools and workflows to create content and leverage that content in Storyteller as simply and easily as possible.
Quick Navigation#
- Quick Start - Get up and running with the API in minutes
- Authentication - Learn how to authenticate your API requests
- Workflows - Understand workflows and content processing
- Content Endpoints - Retrieve published content
- Troubleshooting - Common issues and solutions
API Overview#
The Storyteller Integration API provides comprehensive endpoints for workflow management and content retrieval:
Core Workflow Endpoints#
| Endpoint | Method | Purpose | Documentation |
|---|---|---|---|
/api/workflows |
GET | Retrieve available workflows | View Details → |
/api/workflows/execute |
POST | Execute workflows with your content | View Details → |
/api/workflows/validate |
POST | Validate workflow payload before execution | View Details → |
/api/{correlationId}/status |
GET | Check workflow execution status | View Details → |
Content Endpoints#
| Endpoint | Method | Purpose | Documentation |
|---|---|---|---|
/api/stories |
GET | Retrieve published stories with pagination and search | View Details → |
/api/stories/{externalId}/details |
GET | Load ordered pages, media, and metadata for a story | View Details → |
/api/stories/{externalId}/analytics |
GET | Story-wide engagement charts and per-page totals | View Details → |
/api/stories/by-id/{id}/analytics |
GET | Story-wide engagement charts and per-page totals (by internal GUID) | View Details → |
/api/clips |
GET | Retrieve published clips with pagination and search | View Details → |
/api/clips/{externalId}/analytics |
GET | Clip performance metrics (views, loops, likes) | View Details → |
/api/clips/by-id/{id}/analytics |
GET | Clip performance metrics (by internal GUID) | View Details → |
/api/collections |
GET | Retrieve collections with pagination and search | View Details → |
/api/categories |
GET | Retrieve categories with pagination and search | View Details → |
/api/actions |
GET | Retrieve action links with pagination and search | View Details → |
/api/cards |
GET | Retrieve cards with pagination and search | View Details → |
/api/card-collections |
GET | Retrieve card collections with pagination and search | View Details → |
/api/sheets |
GET | Retrieve sheets with pagination and search | View Details → |
/api/content-bank-assets |
GET | Retrieve content bank assets with pagination and search | View Details → |
/api/content-bank-assets/{externalId} |
GET | Get specific content bank asset by external ID | View Details → |
/api/templates |
GET | Retrieve workflow templates with pagination and search | View Details → |
Complete Sample Implementation#
For a fully functional example showing how to build an integration that handles metadata forms, template properties, and workflow execution, see the Storyteller Sample Integration repository.
This Next.js application demonstrates:
- Dynamic form generation based on workflow templates
- Complete metadata collection and validation
- Real-time workflow status monitoring
- Comprehensive error handling and user feedback
Getting Help#
- Questions? Check our Troubleshooting section
- Need an API Key? Create a "Server" app under Apps in the Storyteller CMS or reach out via [email protected] or Slack for assistance
- Technical Support: Reach out via [email protected] or Slack for assistance
Ready to get started? Head over to our Quick Start Guide to begin integrating with Storyteller.