Everything you need to use Hi-Api.

Hi-Api is built on four simple ideas. Understand these and the rest of the app falls into place.

In short: a schema holds entries, an endpoint exposes that schema over HTTP, and a request token lets your apps call it.

Follow these steps in the dashboard to go from zero to a working API.

1. 1

   Create your account & verify your email

   Sign up with your email and a password. We'll send a verification link — open it to confirm your address. Email verification is required before you can create request tokens or call the API.

2. 2

   Define a schema

   Go to the Schemas tab and create a schema (for example, Note). Add fields and pick a type for each — string, number, boolean, date, or enum. Mark a field required to make it mandatory, or unique to prevent duplicate values.

3. 3

   Add data (optional)

   Open the Entries tab to browse and edit the records in any schema. You can add entries by hand or import a JSON file. You can also skip this and let your app create data through the API instead.

4. 4

   Publish an endpoint

   In the Endpoints tab, create an endpoint from your schema and give it a URL slug (such as notes). Enable the HTTP methods you want, then choose which fields are readable (returned by GET) and writable (accepted when creating or updating records).

5. 5

   Create a request token

   In the Request Tokens tab, mint a token and choose which endpoints it can reach and whether it has read and/or write access. Copy the token when it's shown — you can also reveal it again later, or revoke it whenever you like.

6. 6

   Call your API

   Send requests to your endpoint's URL with the token in the Authorization header. The next section shows exactly how.

Every endpoint lives under a predictable base URL. You'll find the exact URL for each endpoint — with a copy button — on its card in the Endpoints tab.

Base URL

https://d24cgaurqj8x4p.cloudfront.net/api/dx/<your-endpoint>

Authentication

Send your request token as a bearer token on every request. Requests without a valid token are rejected.

Authorization: Bearer mapi_YOUR_TOKEN

Available methods

A method only works if it's enabled on the endpoint and granted to your token.

Example requests

Assuming an endpoint with the slug notes. Replace mapi_YOUR_TOKEN with your token and RECORD_ID with a record's id.

curl -X POST https://d24cgaurqj8x4p.cloudfront.net/api/dx/notes \
  -H "Authorization: Bearer mapi_YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"title":"Buy milk","done":false}'

curl "https://d24cgaurqj8x4p.cloudfront.net/api/dx/notes?done=false&limit=25" \
  -H "Authorization: Bearer mapi_YOUR_TOKEN"

curl https://d24cgaurqj8x4p.cloudfront.net/api/dx/notes/RECORD_ID \
  -H "Authorization: Bearer mapi_YOUR_TOKEN"

curl -X PATCH https://d24cgaurqj8x4p.cloudfront.net/api/dx/notes/RECORD_ID \
  -H "Authorization: Bearer mapi_YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"done":true}'

curl -X DELETE https://d24cgaurqj8x4p.cloudfront.net/api/dx/notes/RECORD_ID \
  -H "Authorization: Bearer mapi_YOUR_TOKEN"

What a response looks like

Records come back with their id, your data, and timestamps. List responses also include a pagination summary.

{
  "records": [
    {
      "id": "665f1c9a2b...",
      "data": { "title": "Buy milk", "done": false },
      "createdAt": "2026-07-05T10:00:00.000Z",
      "updatedAt": "2026-07-05T10:00:00.000Z"
    }
  ],
  "pagination": { "total": 1, "limit": 25, "skip": 0 }
}

When you list records with GET /api/dx/:endpoint, you can narrow and page through the results with query parameters.

• ?field=value — filter by any readable field. Combine several to match all of them, e.g. ?done=false&title=Buy%20milk.
• ?limit= — how many records to return. Default 50, between 1 and 200.
• ?skip= — how many records to skip, for paging. Default 0. To get the second page of 25, use ?limit=25&skip=25.

Records are returned newest first. The pagination.total in the response tells you how many records match your filter, so you know when you've reached the end.

Limits apply to your whole account and are shared across all of your tokens — minting more tokens doesn't raise your throughput. Every API response includes headers so you can track where you stand:

• X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset — your per-minute budget and when it resets.
• X-Quota-Limit, X-Quota-Remaining — your monthly request allowance.

Go over either and requests return 429 until the window resets. Your limits depend on your plan:

Switch plans anytime under Account → Billing.

Every API call returns a standard HTTP status. Here's what each one means and how to resolve it.