REST APIs

This section contains details about the SolidX REST APIs serving different functionalities.

API Overview

Mental Model

The SolidX REST APIs are the primary machine-facing interface of the platform.

The frontend consumes them as the default application runtime contract.
Integrations consume them to automate, synchronize, or extend system behavior.
A large part of the API surface is generated from metadata and backend structure, then extended where implementation-specific behavior is required.

The REST API layer is the runtime contract between your metadata-driven backend and external consumers.

This section covers authentication, generated CRUD routes, recovery flows, and Swagger-based API inspection.

Understand how clients authenticate with generated APIs and how bearer-token based access is enforced across the runtime.

Review generated create endpoints, request payloads, and write-path behavior for new records.

Explore collection and single-record retrieval, including filters, pagination, sorting, field selection, and response semantics.

Understand how generated update routes behave for full and partial record updates.

Review delete semantics, route conventions, and how removal fits into generated CRUD behavior.

Learn how recovery works for soft-deleted records in projects that enable archival and restore workflows.

Use Swagger as the fastest inspection surface for verifying the generated API in a running project.