Auth

Authenticate with your passKey to receive an accessToken required for authorized API requests.

post

/v1/v2

/auth/login

Authenticates a user using a passKey and returns an accessToken with a limited validity period (2 hours). Once the token expires, a new token must be generated. The accessToken must be included in all protected API requests using the following header Authorization: Bearer <accessToken>

Body

application/json

passKeystringRequired

Responses

201Success

application/json

500Error

application/json

post

/auth/login

HTTPcURLJavaScriptPython

POST /v1/auth/login HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "passKey": "text"
}

{
  "roles": [
    "user"
  ],
  "userId": "text",
  "accessToken": "text"
}

Generate a passKey required for authentication.

post

/v1/v2

/auth/generate-passkey

Authorizations

apiKey

x-api-keystringRequired

in header (x-api-key: [key]) or in query (?apiKey=[key])

Body

application/json

userIdstringRequired

Responses

201Success

application/json

500Error

application/json

post

/auth/generate-passkey

HTTPcURLJavaScriptPython

POST /v1/auth/generate-passkey HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "roles": [
    "user"
  ],
  "userId": "text"
}

{
  "roles": [
    "user"
  ],
  "userId": "text",
  "accessToken": "text",
  "passKey": "text",
  "isBot": true,
  "displayName": "text"
}