Default

get
Header parameters
sec-websocket-protocolstringRequiredExample: Authorization, TOKEN
Responses
101
Success message
get
GET /stream HTTP/1.1
Host: 
sec-websocket-protocol: Authorization, TOKEN
Accept: */*
101

Success message

No content
post
Body
verifierstringRequired
Responses
200
Success message
post
POST /oauth/token HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "verifier": "text"
}
No content
post
Body
usernamestringRequired

An awesome username

Example: john_doePattern: ^(?! )[\x20-\x7E]{3,16}(?<! )$
passwordstring · min: 6Required

A good password

Example: password123
challengestringRequired
Responses
200
Success message
post
POST /oauth/authorize HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "username": "john_doe",
  "password": "password123",
  "challenge": "text"
}
No content
post
Path parameters
roomnamestringRequired

Room name

Example: wonkPattern: ^[a-z0-9_]{3,16}$
Header parameters
authorizationstringRequiredExample: Bearer TOKENPattern: ^Bearer .+$
Responses
200
Success message
post
POST /room/:roomname/join HTTP/1.1
Host: 
authorization: Bearer TOKEN
Accept: */*

No content
post
Path parameters
roomnamestringRequired

Room name

Example: wonkPattern: ^[a-z0-9_]{3,16}$
Header parameters
authorizationstringRequiredExample: Bearer TOKENPattern: ^Bearer .+$
Responses
200
Success message
post
POST /room/:roomname/leave HTTP/1.1
Host: 
authorization: Bearer TOKEN
Accept: */*

No content
post
Path parameters
roomnamestringRequired

Room name

Example: wonkPattern: ^[a-z0-9_]{3,16}$
Header parameters
authorizationstringRequiredExample: Bearer TOKENPattern: ^Bearer .+$
Responses
200
Success message
post
POST /room/:roomname/create HTTP/1.1
Host: 
authorization: Bearer TOKEN
Accept: */*

No content
post
Path parameters
roomnamestringRequired

Room name

Example: wonkPattern: ^[a-z0-9_]{3,16}$
Header parameters
authorizationstringRequiredExample: Bearer TOKENPattern: ^Bearer .+$
Body
messagestringRequired
Responses
200
Success message
post
POST /room/:roomname/message HTTP/1.1
Host: 
authorization: Bearer TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "message": "text"
}
No content
get
Path parameters
roomnamestringRequired

Room name

Example: wonkPattern: ^[a-z0-9_]{3,16}$
Header parameters
authorizationstringRequiredExample: Bearer TOKENPattern: ^Bearer .+$
Responses
200
Success message
get
GET /room/:roomname/info HTTP/1.1
Host: 
authorization: Bearer TOKEN
Accept: */*

No content
get
Path parameters
usernamestringRequired

An awesome username

Example: john_doePattern: ^(?! )[\x20-\x7E]{3,16}(?<! )$
Header parameters
authorizationstringRequiredExample: Bearer TOKENPattern: ^Bearer .+$
Responses
200
Success message
get
GET /user/:username/fetch HTTP/1.1
Host: 
authorization: Bearer TOKEN
Accept: */*

No content
post
Header parameters
authorizationstringRequiredExample: Bearer TOKENPattern: ^Bearer .+$
Body
publicKeystringRequired

The public key

signaturestringRequired

The signature of the public key

Responses
200
Success message
post
POST /me/publickey HTTP/1.1
Host: 
authorization: Bearer TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "publicKey": "text",
  "signature": "text"
}
No content
get
Header parameters
authorizationstringRequiredExample: Bearer TOKENPattern: ^Bearer .+$
Responses
200
Success message
get
GET /me/info HTTP/1.1
Host: 
authorization: Bearer TOKEN
Accept: */*

No content
PreviousIdentifiersNextModels