Skip to main content

Generate Key

Generate new API key to access Raccoon-AI engine.

Method: POST Authorization: JWT
https://engine.raccoon-ai.io/auth/token/api/new

Authorization

TypeKeyValue
JWTAuthorizationBearer ##########

Request Body

KeyData TypeRequiredDescription
namestringtrueName for the new key
expire_ininttrueNumber of days that key will be valid (Maximum is 720 days)

Types

{
"name": <string>,
"expire_in": <int>
}

Sample

{
"name": "MyKey",
"expire_in": 1
}

Reponse Body

KeyData TypeDescription
successbooleanIndicate the success of the request
msgstringMessage indicators
error_codeintError code information, only set if success is false
resultjsonResult, only set if success is true. This containes X-Api-Key
gen_atdatetimeGenerated datetime

Types

{
"success": <boolean>,
"msg": <string>,
"error_code": <int | null>,
"result": {
"X-Api-Key": <string>
},
"gen_at": <datetime>
}

Sample

{
"success": true,
"msg": "API Key issued successfully",
"error_code": null,
"result": {
"X-Api-Key": "rae_######################"
},
"gen_at": "2023-06-11T22:05:26.135339"
}