Getting started
From signup to first 200 OK in roughly five minutes. The five steps below are the canonical path; every other surface in the product builds on top of these primitives.
1. Create an account
Sign up at /signup. You'll pick a username (your public namespace; it appears in generated docs URLs like endpointos.dev/{username}/docs/{project}), confirm your email, and land in your personal workspace.
2. Create a project
From the dashboard, click New project. A project bundles resources, API keys, consumers, logs, usage limits, contracts, and webhooks. One project per API surface is the typical pattern (e.g. "feature-requests-api", "leads-api"). Each project gets its own slug and base URL.
3. Define your first resource
A resource is a named data shape. Add fields with types (string, number, boolean, enum, datetime) and rules (required, default, enum values). EndpointOS generates a CRUD API surface for the resource the moment you save:
GET /api/public/{username}/{project}/{resource}
POST /api/public/{username}/{project}/{resource}
GET /api/public/{username}/{project}/{resource}/{id}
PATCH /api/public/{username}/{project}/{resource}/{id}
DELETE /api/public/{username}/{project}/{resource}/{id}4. Issue an API key
Open the API keys tab on your project and click New key. Give it a name (e.g. "Production", "Staging", "Partner X"). The plaintext key is shown exactly once. Copy it now. Subsequent visits show only the prefix and last 4 chars.
5. Make a request
Send the key as a bearer token or via the x-api-key header:
curl -X POST https://endpointos.dev/api/public/you/feature-requests-api/feature-requests \
-H "Authorization: Bearer sapi_live_..." \
-H "Content-Type: application/json" \
-d '{"title":"Add dark mode","submitterEmail":"ada@example.com"}'Hit the Logs tab and you'll see the request, the status, the latency, and the request body (truncated). That's the loop: define → call → observe.
