Overview

Snapp exposes a REST API documented exclusively through OpenAPI 3.1 and rendered with Scalar.

There is no duplicated documentation, no rewritten examples, and no hand-maintained specs. What you see is what the server exposes at runtime.

The API reference is available here:

https://snapp.li/api/docs

What you will find at /api/docs

The documentation page is powered by Scalar and loads multiple OpenAPI sources at once.

Snapp API

The main specification documents the Snapp platform API, including:

• health checks
• shortened URL resolution
• URL CRUD operations
• tag management
• team associations
• metrics and analytics endpoints

The schema reflects:

• real request and response payloads
• actual validation rules
• authentication requirements
• error responses

The OpenAPI document is generated from the live routes and served by Snapp itself.

Better-Auth API

Authentication is handled by Better-Auth.

Its OpenAPI specification is not duplicated or rewritten. Instead, it is loaded as a separate source inside the same Scalar instance.

From the same /api/docs page you can switch between:

• Snapp API
• Better-Auth API

Each specification remains isolated, but both are accessible from the same UI.

Authentication

All Snapp API endpoints require authentication.

• Requests must include a Bearer token
• The token is validated as an API key
• The key is scoped to a specific host
• Permissions are enforced per organization

Requests from unknown origins are rejected before authentication.

Typical responses:

• 401 – missing or invalid API key
• 403 – unrecognized host or insufficient permissions

Scope of this reference

This page documents only the public HTTP APIs.

It intentionally does not cover:

• UI behavior
• internal services
• database schema
• background jobs or workers

If it is not visible in /api/docs, it is not part of the public API surface.

Use the Scalar interface to explore endpoints, inspect schemas, and issue test requests against your Snapp instance.