S
supero.docs
Developers

Developers

SDK, API and integration reference.

Developers

SDK, API and integration reference.

Architecture

The mental model you need before integrating: one public API host, how a request is authenticated and scoped, how the schema drives everything downstream, and how tenant isolation

Platform Concepts

The core mental model behind Supero: how domains, projects, tenants, and namespaces isolate your data, how schemas drive the API, and how roles and policies control access.

Operations & Observability

What Supero records, where each kind of record is read from, how to follow one request across the whole platform, what to check when something fails — and, stated plainly, which ob

Debugging & Troubleshooting

The one skill that matters most on Supero: telling apart responses that look identical but mean different things. A 200 with an empty list has four causes; a connector run that say

API Overview & Conventions

The conventions every Supero REST endpoint follows: one base URL, two route families, two auth schemes, and one response envelope. Read this before any individual endpoint referenc

Authentication

How to authenticate against the Supero API with a login-issued JWT or a long-lived API key, and how to manage token lifecycle.

OpenAPI Export & Developer Tools

Export a machine-readable OpenAPI 3.0.3 document for your schemas, try endpoints in the playground, and hand the spec to a frontend generator. The console's developer tools, and th

CRUD Endpoints

The auto-generated Create, Read, Update, and Delete endpoints every schema type gets on api.supero.dev, plus bulk reads, rich queries, and batch writes.

Querying & Pagination

How to filter, sort, page through, and aggregate CRUD data across GET list, POST /list-bulk, and POST /query — plus references and fully-qualified-name resolution.

Errors & Status Codes

Every status code the Supero API returns and what it actually means here, the error body shapes, the error_code values worth branching on — and the failures that come back as 200.

Rate Limits & Quotas

How Supero limits traffic: the per-surface request-rate limits and their 429 contract, the plan quota system and its 402 contract, and the per-request size and count limits that ap

Schema API

Create, validate, read, update, and delete schema definitions over REST — the same operations the dashboard, CLI, and AI Assistant use under the hood.

Domains, Projects & Tenants API

Reference for the account hierarchy Supero is built on -- Domain, Project, and Tenant -- and the REST endpoints for registering a domain and managing tenant lifecycle.

Plugins API

REST API reference for the Plugin Registry — register your own HTTP endpoint as a project-scoped plugin, invoke it through the platform gateway, and monitor its health.

AI Agent API

Talk to your domain's data in natural language: the AI Data Agent turns your uploaded schemas into callable tools, runs a reasoning loop over them, and returns structured results —

Billing & Usage API

Read-only endpoints for pulling your domain's current-period usage, plan catalog, prepaid Power-credit wallet, and add-on catalog into your own dashboards or alerts.

Python SDK

The official Python client for Supero — a synchronous library that wraps the REST API with a connected "org" object, a fluent query builder, schema upload, and file handling.

JavaScript SDK

The Supero JavaScript SDK (@supero/js-lib) is a Node.js client for authenticating, running CRUD, and calling platform services against api.supero.dev.

Custom / Per-Domain SDK

Generate a typed Python or JavaScript client library from your own domain\'s schemas, and manage its versions through the SDK Generation API.

Build an App with Your Own AI Agent

Use your own coding agent (Claude Code, Cursor, or similar) to author a full Supero app locally, then validate, publish, and deploy it over the Supero MCP server.

GitHub Resources

The open sample applications: nineteen production-shaped apps across industry verticals, each with its schemas, setup, tests and editor rules — readable, clonable, and the fastest

CLI (App Runner)

The supero command line tool that sets up and runs a generated Supero app on your machine — not a general-purpose account/management CLI.

Connect Your AI Editor over MCP

Point Claude Code, Cursor, or GitHub Copilot at Supero's MCP server and build, validate, publish, and deploy real Supero apps without leaving your editor.

Build an App over MCP

The end-to-end path: mint a correctly scoped API key, connect your editor, drive a build through the build_* tools, and deploy — either a short-lived preview or a permanent one.

MCP Integration Services

How a generated app calls external MCP tool servers (services.mcpClient) and exposes its own schemas as MCP tools (services.mcpServer) — the services.* wrapper pair for Model Conte

Workflow Engine Reference (Steps, Templates, Sagas)

The full reference for the Workflow Engine service: step types, template syntax, error handling, and saga compensation for orchestrating multi-step business logic across your impor