Skip to main content
POST
/
v1
/
sessions
/
stop
Stop Session
curl --request POST \
  --url https://api.example.com/v1/sessions/stop \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "reason": "USER_CLOSED"
}
'
{
  "code": 100,
  "data": "<unknown>",
  "message": "<string>"
}

Authorizations

​
X-API-KEY
string
header
required

Body

application/json
​
session_id
string<uuid>
​
reason
enum<string>
default:UNKNOWN
Available options:
UNKNOWN,
USER_DISCONNECTED,
SERVER_ERROR,
IDLE_TIMEOUT,
NO_CREDITS,
USER_CLOSED,
AVATAR_DELETED,
MAX_DURATION_REACHED,
ZOMBIE_SESSION_REAP

Response

Successful Response

​
code
integer
default:100
​
data
any
​
message
string