Skip to main content

CMS API Introduction

The Streams Platform CMS API provides a powerful, flexible way to manage and query custom content types through a GraphQL interface. Built for developers who need dynamic content management with type-safe client libraries, our CMS enables you to create custom data structures and access them seamlessly across your applications.

What is the CMS API?​

The CMS API is a GraphQL-based content management system that allows you to:

  • Create Custom Content Types: Define your own data structures with custom fields
  • Auto-Generated TypeScript Clients: Get type-safe API clients automatically generated for your content types
  • Flexible Querying: Use cursor-based pagination, filtering, and sorting
  • Asset Management: Handle images and files with built-in asset support
  • Real-time Updates: Content changes are immediately available via the API

Key Features​

Custom Content Types​

Create any content structure you need - from simple blog posts to complex product catalogs. Each content type becomes a fully-featured API endpoint with CRUD operations.

Type-Safe Clients​

Every custom content type gets an auto-generated TypeScript client with:

  • Full type definitions
  • Pagination support (cursor and page-based)
  • Advanced filtering capabilities
  • Sorting and ordering options
  • Built-in error handling

GraphQL Foundation​

Built on GraphQL, providing:

  • Single endpoint for all queries
  • Efficient data fetching
  • Strong typing
  • Introspection capabilities

Asset Management​

Integrated support for images and files with:

  • Automatic thumbnail generation
  • CDN delivery
  • Multiple format support
  • Metadata extraction

Use Cases​

The CMS API is perfect for:

  • Dynamic Websites: Content-driven sites that need flexible data structures
  • Mobile Applications: Type-safe clients for React Native and other frameworks
  • E-commerce: Product catalogs, inventory management, and content marketing
  • Corporate Websites: Employee directories, news, announcements, and company information
  • Marketing Campaigns: Landing pages, promotional content, and campaign management

Architecture Overview​

┌─────────────────┐    ┌──────────────────┐    ┌─────────────────┐
│   Your App      │    │   CMS API        │    │   Content       │
│                 │    │                  │    │   Storage       │
│ ┌─────────────┐ │    │ ┌──────────────┐ │    │                 │
│ │ Generated   │─┼────┼─│   GraphQL    │─┼────┤                 │
│ │ TypeScript  │ │    │ │   Endpoint   │ │    │                 │
│ │ Clients     │ │    │ └──────────────┘ │    │                 │
│ └─────────────┘ │    │                  │    │                 │
└─────────────────┘    └──────────────────┘    └─────────────────┘

Getting Started​

Ready to start using the CMS API? Check out our Getting Started Guide to:

  1. Set up your first content type
  2. Generate your TypeScript client
  3. Make your first API calls
  4. Implement advanced features like filtering and pagination

Next Steps​