API Reference
Technical reference for all Propeller APIs, SDKs and plugins.
All reference content covers v2 of the APIs. Legacy v1 documentation is available separately for partners with existing v1 implementations.
| Reference | Description |
|---|---|
| GraphQL API | Endpoint and headers, error format, interactive explorer, queries, mutations and types |
| REST API | Base URL and authorization, interactive explorer and every endpoint by domain |
| Storefront SDK | React and Vue component libraries: the component and hook inventory and the provider model |
| Deprecations | Deprecated GraphQL and REST items, their replacements and the removal date |
| Legacy APIs | v1 GraphQL, v1 REST and REST SonarCloud for existing implementations |
Machine-readable resources
For tooling and AI assistants:
- OpenAPI specs (REST): the OpenAPI manifest lists one spec file per service.
- GraphQL schema: download the schema SDL, or introspect the live endpoint with an API key.
- Documentation as Markdown: every guide page and every REST endpoint page has a Markdown version at the same URL with
.mdin place of the trailing slash. The GraphQL reference pages do not. Use the schema SDL for those. - llms.txt: the llms.txt index and the full-text llms-full.txt for language models.