Getting started

Build your first API

1. 1. Create a project and API

   Sign in, create a project, and use the API builder to define your first API. Pick a name, version, and base path; endpoints come next.

2. 2. Model your data

   Create tables with typed columns in the Database section, or connect an existing Postgres/MySQL database through a connector. Endpoints can read and write these tables directly.

3. 3. Add endpoints

   Each endpoint gets a method, path, request/response schema, and an optional query against your data. Schema validation runs on every request before your logic executes.

4. 4. Test in the playground

   The built-in playground sends real requests against your endpoints and shows the raw response, so you can iterate without leaving the dashboard.

5. 5. Publish and issue keys

   Publishing generates an OpenAPI spec that stays in sync with your configuration. Issue scoped API keys (read, write, admin) with optional expiry, and revoke them at any time.

Calling your API

Published endpoints are authenticated with an API key in the x-api-key header. Keys are shown once at creation and can be scoped and revoked from the dashboard.

curl https://api.nexapi.run/v1/your-api/customers \
  -H "x-api-key: nxa_your_key_here" \
  -H "content-type: application/json"

const res = await fetch(
  "https://api.nexapi.run/v1/your-api/customers",
  {
    headers: {
      "x-api-key": process.env.NEXAPI_KEY,
      "content-type": "application/json",
    },
  },
);

const customers = await res.json();

What's included