Default

get

Header parameters

sec-websocket-protocolstringRequiredExample: Authorization, TOKEN

Responses

101

Success message

get

/stream

HTTPcURLJavaScriptPython

GET /stream HTTP/1.1
Host: 
sec-websocket-protocol: Authorization, TOKEN
Accept: */*

101

Success message

No content

post

Body

application/json

verifierstringRequired

Responses

200

Success message

No content

400

Returns an error

application/json

post

/auth/token

HTTPcURLJavaScriptPython

POST /auth/token HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "verifier": "text"
}

No content

post

Body

application/json

usernamestringRequired

An awesome username

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

passwordstring · min: 6Required

A good password

Example: password123

challengestringRequired

Responses

200

Success message

No content

400

Returns an error

application/json

500

Something went wrong internally

application/json

post

/auth/authorize

HTTPcURLJavaScriptPython

POST /auth/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

roomidstringRequired

Snowflake ID

Pattern: ^[0-9a-z]+$

Header parameters

authorizationstringRequiredExample: Bearer TOKENPattern: ^Bearer .+$

Responses

200

Success message

No content

400

Returns an error

application/json

500

Something went wrong internally

application/json

post

/room/:roomid/join

HTTPcURLJavaScriptPython

POST /room/:roomid/join HTTP/1.1
Host: 
authorization: Bearer TOKEN
Accept: */*

No content

post

Path parameters

roomidstringRequired

Snowflake ID

Pattern: ^[0-9a-z]+$

Header parameters

authorizationstringRequiredExample: Bearer TOKENPattern: ^Bearer .+$

Responses

200

Success message

No content

400

Returns an error

application/json

500

Something went wrong internally

application/json

post

/room/:roomid/leave

HTTPcURLJavaScriptPython

POST /room/:roomid/leave HTTP/1.1
Host: 
authorization: Bearer TOKEN
Accept: */*

No content

post

Header parameters

authorizationstringRequiredExample: Bearer TOKENPattern: ^Bearer .+$

Body

application/json

namestring · min: 3 · max: 100Required

Room name

Example: wonk

Responses

200

Success message

No content

400

Returns an error

application/json

post

/room/create

HTTPcURLJavaScriptPython

POST /room/create HTTP/1.1
Host: 
authorization: Bearer TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "wonk"
}

No content

post

Path parameters

roomidstringRequired

Snowflake ID

Pattern: ^[0-9a-z]+$

Header parameters

authorizationstringRequiredExample: Bearer TOKENPattern: ^Bearer .+$

Body

application/json

messagestringRequired

Responses

200

Success message

No content

400

Returns an error

application/json

post

/room/:roomid/message

HTTPcURLJavaScriptPython

POST /room/:roomid/message HTTP/1.1
Host: 
authorization: Bearer TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "message": "text"
}

No content

get

Path parameters

roomidstringRequired

Snowflake ID

Pattern: ^[0-9a-z]+$

Header parameters

authorizationstringRequiredExample: Bearer TOKENPattern: ^Bearer .+$

Responses

200

Success message

No content

400

Returns an error

application/json

get

/room/:roomid/info

HTTPcURLJavaScriptPython

GET /room/:roomid/info HTTP/1.1
Host: 
authorization: Bearer TOKEN
Accept: */*

No content

post

Path parameters

roomidstringRequired

Snowflake ID

Pattern: ^[0-9a-z]+$

Header parameters

authorizationstringRequiredExample: Bearer TOKENPattern: ^Bearer .+$

Responses

200

Success message

No content

400

Returns an error

application/json

500

Something went wrong internally

application/json

post

/room/:roomid/create-invite

HTTPcURLJavaScriptPython

POST /room/:roomid/create-invite HTTP/1.1
Host: 
authorization: Bearer TOKEN
Accept: */*

No content

post

Header parameters

authorizationstringRequiredExample: Bearer TOKENPattern: ^Bearer .+$

Body

application/json

codestringRequired

Responses

200

Success message

No content

400

Returns an error

application/json

post

/room/use-invite

HTTPcURLJavaScriptPython

POST /room/use-invite HTTP/1.1
Host: 
authorization: Bearer TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "code": "text"
}

No content

get

Path parameters

idstringRequired

Snowflake ID

Pattern: ^[0-9a-z]+$

Header parameters

authorizationstringRequiredExample: Bearer TOKENPattern: ^Bearer .+$

Responses

200

Success message

No content

400

Returns an error

application/json

get

/user/:id/fetch

HTTPcURLJavaScriptPython

GET /user/:id/fetch HTTP/1.1
Host: 
authorization: Bearer TOKEN
Accept: */*

No content

post

Header parameters

authorizationstringRequiredExample: Bearer TOKENPattern: ^Bearer .+$

Body

application/json

publicKeystringRequired

The public key

signaturestringRequired

The signature of the public key

Responses

200

Success message

No content

400

Returns an error

application/json

post

/me/publickey

HTTPcURLJavaScriptPython

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

No content

400

Returns an error

application/json

get

/me/info

HTTPcURLJavaScriptPython

GET /me/info HTTP/1.1
Host: 
authorization: Bearer TOKEN
Accept: */*

No content

get

Header parameters

authorizationstringRequiredExample: Bearer TOKENPattern: ^Bearer .+$

Responses

200

Success message

application/json

get

/media/upload/info

HTTPcURLJavaScriptPython

GET /media/upload/info HTTP/1.1
Host: 
authorization: Bearer TOKEN
Accept: */*

200

Success message

{
  "success": true,
  "maxChunkSize": 52428800
}

post

Header parameters

authorizationstringRequiredExample: Bearer TOKENPattern: ^Bearer .+$

Body

application/json

namestring · min: 1Required

The name of the file

sizeinteger · min: 1Required

The total length of the file in bytes

mimeTypestringRequired

The mime type of the file

hashesstring[] · min: 1Required

A list of hashes of the file

Responses

200

Success message

application/json

400

Returns an error

application/json

500

Returns an error

application/json

post

/media/upload/init

HTTPcURLJavaScriptPython

POST /media/upload/init HTTP/1.1
Host: 
authorization: Bearer TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "name": "text",
  "size": 1,
  "mimeType": "text",
  "hashes": [
    "text"
  ]
}

{
  "success": true,
  "uploadId": "text"
}

patch

Path parameters

idstringRequired

Body

multipart/form-data

anyOptional

Responses

200

Success message

application/json

400

Returns an error

application/json

patch

/media/upload/:id

HTTPcURLJavaScriptPython

PATCH /media/upload/:id HTTP/1.1
Host: 
Content-Type: multipart/form-data
Accept: */*

{
  "success": true
}

post

Path parameters

idstringRequired

Header parameters

authorizationstringRequiredExample: Bearer TOKENPattern: ^Bearer .+$

Body

application/json

checksumstringRequired

A sha256 checksum of the file

Responses

200

Success message

No content

400

Returns an error

application/json

post

/media/upload/:id/complete

HTTPcURLJavaScriptPython

POST /media/upload/:id/complete HTTP/1.1
Host: 
authorization: Bearer TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "checksum": "text"
}

No content

get

Path parameters

idstringRequired

filenamestringRequired

Responses

200

The requested file

No content

get

/media/:id/:filename

HTTPcURLJavaScriptPython

GET /media/:id/:filename HTTP/1.1
Host: 
Accept: */*

200

The requested file

No content