API Reference

The AuthOS API serves as the backend for authentication operations. It is designed to be consumed by the AuthOS SDKs or directly by HTTP clients.

Base URL

By default, the API runs on:

http://localhost:3001

Authentication

All Client API requests utilize the Authorization header with a Bearer token containing your Publishable Key.

Authorization: Bearer <YOUR_PUBLISHABLE_KEY>

Endpoints

Client API

Sign In

Authenticate an existing user.

POST /v1/client/sign-in

Request Body

Response (200 OK)

{
  "token": "eyJhbGciOiJIUzI1Ni...",
  "user": {
    "id": "usr_123",
    "email": "user@example.com",
    "name": "John Doe",
    "image": "..."
  }
}

Sign Up

Register a new user account.

POST /v1/client/sign-up

Request Body

Response (201 Created)

{
  "user": {
    "id": "usr_123",
    "email": "user@example.com",
    "name": "John Doe",
    "image": "..."
  }
}