Skip to content

Markdown Source

Use the raw markdown for copy, automation, and AI agents.

View Markdown

Auth API

Request Email Code

prolog
POST API_BASE/auth/code

Authorization Required

OAuthAPIKey
NoNo

Request Body

json
{
  "email": "user@example.com",
  "lang": "en",
  "scene": "login"
}

scene can be login or replace_email.

Response

json
{
  "data": null,
  "ts": 1723923923
}

Request Google OAuth URL

prolog
POST API_BASE/auth/google/url?state=:state

Parameters

ParameterTypeDescription
statestringOAuth state value (required).

Response

json
{
  "data": {
    "url": "https://..."
  },
  "ts": 1723923923
}

Login

prolog
POST API_BASE/auth/login

Request Body

json
{
  "method": "email_code",
  "email": "user@example.com",
  "code": "123456",
  "lang": "en"
}

For Google OAuth login:

json
{
  "method": "google_oauth",
  "code": "oauth_code",
  "state": "state",
  "lang": "en"
}

Response

json
{
  "data": {
    "user": UserObject,
    "access_token": "..."
  },
  "ts": 1723923923
}

Issue Ephemeral Token

prolog
POST API_BASE/auth/ephemeral?origin=:origin

Authorization Required

OAuthAPIKey
YesYes

Parameters

ParameterTypeDescription
originstringThe origin for the ephemeral token.

Response

json
{
  "data": {
    "ephemeral_token": "..."
  },
  "ts": 1723923923
}

Exchange Ephemeral Token

prolog
POST API_BASE/auth/ephemeral/exchange?token=:token

Parameters

ParameterTypeDescription
tokenstringEphemeral token (required).

Response

json
{
  "data": {
    "user": UserObject,
    "access_token": "..."
  },
  "ts": 1723923923
}