Workflow · API
A REST API, the moment you save a model.
Start an API project, describe your data, switch on the actions you want, choose who may call them. Paging, filters, search, customer accounts, webhooks and a live reference come with it — there is no server to write or run.
You end with
A documented REST API for your site, app or script — with customer sign-in.
Under an hour
- 1Start an API project
- 2Model your data
- 3Generate its endpoints
- 4Set its rules
- 5Add customer sign-in
- 6Call it
- 7Check it in the reference
- 8Tell your other systems
Step by step
8 steps. Here’s each one.
- 01YouProjects → New → API
Start an API project
Choose API when you create the project. Start from a template — a booking API, a products & orders API — and its models, endpoints, customer sign-in and webhooks arrive set up; or start from scratch and add your own.
- A template is a head start: change every model and endpoint in it
- Or a blank API project, built your way
- Its sidebar leads with the API: overview, endpoints, keys, reference
- 02YouYour AIBuild → Models
Model your data
Make the models your API serves — products, bookings, posts — in the model builder, or ask your AI to build them. Validation, links and formulas are part of the model, so the API enforces them.
- Required fields, allowed values, min/max, unique
- Links between models; formulas worked out on the server
- See how models are built in the models workflow
- 03YouAPI → Endpoints
Generate its endpoints
Generate a model’s endpoints in one go — list, read one, create, update, delete — or make your own at the address you choose: /products/featured, /my/orders, /contact. They answer at once.
- Generate from a model, or a four-step New endpoint
- Any address, several endpoints per model
- GET on the address describes every endpoint and its fields
- 04YouAPI → Endpoints → an endpoint
Set its rules
Per endpoint: who can call it — anyone, your signed-in customers, or your own server with a key — which records it reaches, which fields go out and which a call may write, and how a list is filtered and paged.
- Rules like “status is published” or “owner is the signed-in customer”
- Server keys for your own server, scripts and partners
- Fields sent back and written — an order’s status set by you, never by a request
- Fixed filters, order and page sizes for a list
- 05YouAPI → Customers
Add customer sign-in
Drop in the sign-in widget, use MintAuth in your code, or post from your own form. Customers get accounts in your project, and you manage them from the panel.
- A ready widget — sign up, sign in, sign out
- Tokens per project, sent with each call
- Customers listed and managed in the panel
- 06YouYour site, app or script
Call it
Every list takes paging, sorting, field filters, date ranges and search — and can return only the fields you ask for. Errors say exactly what was wrong.
- ?status=available&rate_lte=300&sort=-rating
- Filters by kind of field, and by date
- 400 with a plain message, 401, 404, 429 with Retry-After
- 07MINTAPI → Reference
Check it in the reference
Each project documents its own API from what the live API offers, so it always matches its endpoints. Every endpoint comes as a curl and a fetch example to paste, and the tester sends real requests.
- Every endpoint your site or app can call
- Copy-paste examples: curl and fetch
- A tester to send real requests
- 08YouAPI → Webhooks
Tell your other systems
When a record is created, changed or deleted — from your app, the panel or your AI — MINT posts it to your server, signed so you know it’s real. A failed delivery is retried, and every one is logged.
- Per model: created, changed, deleted
- Signed with a secret (HMAC-SHA256); a test button
- Retried 3 times; the last 50 deliveries kept
Included
What you didn’t have to write.
The plumbing behind every API, done once and done properly.
Endpoints
- CRUD for every model
- Paging, sorting, filters, search
- Choose the fields that come back
- Formulas computed on every save
- Webhooks: signed, retried, logged
Auth
- Customer sign-up and sign-in
- Own-records-only access
- Tokens scoped to the project
- Sign-in attempts rate-limited
Safety
- Validation with plain error messages
- 300 requests a minute per visitor
- Private records never served
- Archived projects stop answering
More workflows
Pick the next thing to build.
Start at step one. We’ll save you a spot.
Join the waitlist and we’ll open a workspace for your team — set up for what you want to build.