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 | Interactive explorer, authentication, queries, mutations, types and error codes |
| REST API | Interactive explorer, authentication, endpoints and error codes |
| Storefront SDK | 54 pre-built React components with properties, callbacks and usage examples |
| 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: append
.mdto any documentation URL to get its Markdown source. - llms.txt: the llms.txt index and the full-text llms-full.txt for language models.