Documentation - KB RolePlay

Description: Get the sentences of a category

Ratelimit: 5 per 10s

Permission: languages.read

Required parameters

Name	Type	Description
serverId	number	The server id
category	string	The category you want to get the sentences from

Query parameters

Name	Type	Description	Default
lang	string	The language you want to get the sentences from	Player's language

Available codes

Status	Code	Description
200	`OK`	The request has been successfully completed
400	`INVALID_LANG`	The value doesn't follow the requirements
400	`INVALID_SERVER_ID`	The server id is invalid
401	`UNAUTHORIZED`	The token is invalid or expired
403	`ACCESS_DENIED`	The token or the author does not have the required permissions
403	`DISCORD_CONNECTION_REQUIRED`	You need a Discord account link to your Steam Account to access to the route
404	`CATEGORY_NOT_FOUND`	The category you specified was not found
404	`SERVER_NOT_FOUND`	The server does not exist
500	`INTERNAL_ERROR`	An internal error has occured

Response structure

code: "OK"
data[]:
- id: number
- category: string
- name: string
- defaultSentence: string
- serverId: number | null
- translations[]:
  - language:
    - alpha2: string
    - name: string
  - sentence: string | null
  - name: string
  - category: string

Description: Get the translations of a sentence

Ratelimit: 5 per 10s

Permission: languages.read

Required parameters

Name	Type	Description
serverId	number	The server id
category	string	The category you want to get the sentences from
sentence	string	The sentence you want to get

Available codes

Status	Code	Description
200	`OK`	The request has been successfully completed
400	`INVALID_SERVER_ID`	The server id is invalid
401	`UNAUTHORIZED`	The token is invalid or expired
403	`ACCESS_DENIED`	The token or the author does not have the required permissions
403	`DISCORD_CONNECTION_REQUIRED`	You need a Discord account link to your Steam Account to access to the route
404	`CATEGORY_NOT_FOUND`	The category you specified was not found
404	`LANGUAGE_NOT_FOUND`	The language you specified was not found
404	`SENTENCE_NOT_FOUND`	The sentence you specified was not found
404	`SERVER_NOT_FOUND`	The server does not exist
404	`TRANSLATION_NOT_FOUND`	The translation of the sentence you specified was not found
500	`INTERNAL_ERROR`	An internal error has occured

Response structure

code: "OK"
data: string

Description: Get the all languages categories

Ratelimit: 5 per 10s

Permission: languages.read

Required parameters

Name	Type	Description
serverId	number	The server id

Available codes

Status	Code	Description
200	`OK`	The request has been successfully completed
400	`INVALID_SERVER_ID`	The server id is invalid
401	`UNAUTHORIZED`	The token is invalid or expired
403	`ACCESS_DENIED`	The token or the author does not have the required permissions
403	`DISCORD_CONNECTION_REQUIRED`	You need a Discord account link to your Steam Account to access to the route
404	`SERVER_NOT_FOUND`	The server does not exist
500	`INTERNAL_ERROR`	An internal error has occured

Response structure

code: "OK"
data: string[]

Description: Get the translations of some sentences

Ratelimit: 5 per 10s

Permission: languages.read

Required parameters

Name	Type	Description
serverId	number	The server id
sentences	string	The sentences you want to get with a specific format: `.;.`

Query parameters

Name	Type	Description	Default
lang	string	The language you want to get the sentences from	Player's language

Available codes

Status	Code	Description
200	`OK`	The request has been successfully completed
400	`INVALID_LANG`	The value doesn't follow the requirements
400	`INVALID_SERVER_ID`	The server id is invalid
401	`UNAUTHORIZED`	The token is invalid or expired
403	`ACCESS_DENIED`	The token or the author does not have the required permissions
403	`DISCORD_CONNECTION_REQUIRED`	You need a Discord account link to your Steam Account to access to the route
404	`LANGUAGE_NOT_FOUND`	The language you specified was not found
404	`SENTENCES_NOT_FOUND`	Some sentences were not found (see the `invalidSentences` field in the response for more details)
404	`SERVER_NOT_FOUND`	The server does not exist
500	`INTERNAL_ERROR`	An internal error has occured

Response structure

code: "OK"
data[]:
- id: number
- category: string
- name: string
- defaultSentence: string
- serverId: number | null
- translations[]:
  - language:
    - alpha2: string
    - name: string
  - sentence: string | null
  - name: string
  - category: string

Description: Change the translations of a category

Ratelimit: 5 per 10s

You need to access to the languages.{alpha2}.manage scope to use this endpoint

Required parameters

Name	Type	Description
serverId	number	The server id
category	string	The category you want to change the translations of

Required body

Key	Type	Structure	Description	Default	Required
sentences	array	id: `number` sentence: `string`	The sentences you want to change the translations of	❌	✅

Available codes

Status	Code	Description
200	`OK`	The request has been successfully completed
400	`BAD_BODY`	The request body is invalid
400	`INVALID_SENTENCE_ID`	The sentence id you specified was not found in the category
400	`INVALID_SENTENCES`	The value `sentences` doesn't follow the requirements
400	`INVALID_SERVER_ID`	The server id is invalid
400	`MISSING_BODY`	The request does not have a body
401	`UNAUTHORIZED`	The token is invalid or expired
403	`ACCESS_DENIED`	The token or the author does not have the required permissions
403	`DISCORD_CONNECTION_REQUIRED`	You need a Discord account link to your Steam Account to access to the route
404	`CATEGORY_NOT_FOUND`	The category you specified was not found
404	`LANGUAGE_NOT_FOUND`	The language you specified was not found
404	`SERVER_NOT_FOUND`	The server does not exist
500	`INTERNAL_ERROR`	An internal error has occured

Response structure

code: "OK"

Description: Set the language of your account

Ratelimit: 5 per 10s

Permission: languages.set

Required parameters

Name	Type	Description
serverId	number	The server id
langAlpha2	string	The language you want to have for your account

Available codes

Status	Code	Description
200	`OK`	The request has been successfully completed
400	`INVALID_SERVER_ID`	The server id is invalid
401	`UNAUTHORIZED`	The token is invalid or expired
403	`ACCESS_DENIED`	The token or the author does not have the required permissions
403	`DISCORD_CONNECTION_REQUIRED`	You need a Discord account link to your Steam Account to access to the route
404	`LANGUAGE_NOT_FOUND`	The language you specified was not found
404	`SERVER_NOT_FOUND`	The server does not exist
500	`INTERNAL_ERROR`	An internal error has occured

Response structure

code: "OK"

GET /api/v2/:serverId/languages/:category

GET /api/v2/:serverId/languages/:category/:sentence

GET /api/v2/:serverId/languages/categories

GET /api/v2/:serverId/languages/translations/:sentences

POST /api/v2/:serverId/languages/:langAlpha2/translations/:category

POST /api/v2/:serverId/me/languages/:langAlpha2