health.getService

GET

const url = 'https://example.com/';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/

Shows where to find the API reference, the Better Auth routes and the user token routes.

Responses

200

Success

application/json

object

name

required

string

Allowed values: OpenBot API

documentation

required

string

Allowed values: /docs

openapi

required

string

Allowed values: /openapi.json

auth

required

string

Allowed values: /auth

tokens

required

string

Allowed values: /v1/user/tokens

Example

{
  "name": "OpenBot API",
  "documentation": "/docs",
  "openapi": "/openapi.json",
  "auth": "/auth",
  "tokens": "/v1/user/tokens"
}

503

RequestFailed

application/json

object

_tag

required

string

Allowed values: RequestFailed

category

required

string

Allowed values: invalid forbidden not_found conflict unavailable external outcome_unknown interrupted

errorId

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "RequestFailed",
  "category": "invalid"
}