Skip to main content
POST
/
api
/
v5
/
sessions
/
bot
Register a bot session
curl --request POST \
  --url https://apix.us.amity.co/api/v5/sessions/bot \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "deviceId": "<string>",
  "deviceInfo": {
    "model": "<string>",
    "sdkVersion": "<string>"
  }
}
'
{
  "accessToken": "<string>",
  "issuedAt": "2023-11-07T05:31:56Z",
  "expiresAt": "2023-11-07T05:31:56Z",
  "users": [
    {
      "userId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "_id": "<string>",
      "path": "<string>",
      "userInternalId": "<string>",
      "userPublicId": "<string>",
      "roles": [
        "<string>"
      ],
      "permissions": [],
      "displayName": "<string>",
      "profileHandle": "<string>",
      "description": "<string>",
      "avatarFileId": "<string>",
      "avatarCustomUrl": "<string>",
      "flagCount": 123,
      "hashFlag": {
        "bits": 123,
        "hashes": 123,
        "hash": [
          "<string>"
        ]
      },
      "metadata": {},
      "isGlobalBan": true,
      "isBrand": true,
      "isDeleted": true
    }
  ],
  "roles": [],
  "files": [],
  "lastCachePurge": "2023-11-07T05:31:56Z",
  "userType": "bot"
}

Headers

​
x-api-key
string
required

API key for network authentication

Body

application/json

Information about bot user and devices that they use to connect. Bot users have read-only access and are typically used for SEO crawlers and automated systems.

accessToken expires in 30 days by default.

​
deviceId
string
required

Unique identifier for the device

Required string length: 1 - 150
​
deviceInfo
object

Optional device information for analytics and debugging

Response

Session Information with access token and user data

​
accessToken
string
required

JWT access token for API authentication

​
issuedAt
string<date-time>
required

Token issuance timestamp

​
expiresAt
string<date-time>
required

Token expiration timestamp

​
users
object[]
required

User information array

​
roles
object[]

User roles array

Example:
[]
​
files
object[]

Associated files array

Example:
[]
​
lastCachePurge
string<date-time>

Date of the last cache purge

​
userType
enum<string>

Type of user (e.g., signed-in, visitor, bot)

Available options:
signed-in,
visitor,
bot
Example:

"bot"