Orbit generates a REST API from your app's data model so other software can work with your app's data.
The data model defines the API
Orbit generates a route set for each entity and an OpenAPI 3.0 document at /openapi.json on your app's address, according to the Orbit product overview.
An entity describes a kind of record, such as a task. The generated API gives other software a way to work with those records without using your app's pages.
For example, a task app might have a tasks entity with a title field. A task titled Buy milk is one record. These names are examples, not built-in entities.
Read Entities and records for the difference between an entity and its records.
The app describes its own operations
The product overview lists GET, POST, PATCH, and DELETE for the generated route sets. Your app's OpenAPI document describes the API for your app.
Use that document to find the actual paths, request fields, responses, and security requirements before you connect a client. Do not construct a route from an entity name alone.
In the task example, tasks and title describe the model. The app's OpenAPI document describes the available operations and their request and response formats.
This page explains the feature. It does not define a shared request body or response format for every generated app.
API descriptions and access rules
An API description does not prove which records a caller can access. Authentication explains the difference between sign-in and permission to read a record.
The app API is not the Orbit platform API
Your app's generated API works with your app's data. The Orbit platform API works with Orbit resources, such as apps, organizations, and deployments.
A request that lists your Orbit projects does not list the task records inside one project. Do not reuse a platform API example as an app data request.
Use the REST API overview when you need to manage Orbit resources. Before you expose app data, review the app before launch and test its access rules.