SpecStory Cloud API

Overview

SpecStory Cloud provides a REST API for core CRUD operations for projects and AI chat sessions, and a GraphQL API for querying.

Authentication

All REST and GraphQL requests require an API key be passed via a Bearer token in the Authorization header.

Manage your API keys here.

GraphQL

In additional to the REST API for CRUD, a GraphQL API is available for querying.

• GraphQL Endpoint: via a POST request to /api/v1/graphql for querying with filtering and data selection
• GraphQL Explorer: visit the interactive GraphQL playground in your browser

GraphQL APIs are designed to be self-documenting through their strongly-typed schema system. Every GraphQL service exposes its complete schema through introspection, allowing clients to query the API itself to discover available types, fields, arguments, and their relationships. This introspection capability means that tools can automatically generate comprehensive, always up-to-date documentation directly from the schema definition.