POST /card
Creates a Welcome/Boost card
Headers
| Name | Value |
|---|---|
| apikey | 28-Character API Key |
Body
| Name | Type | Description |
|---|---|---|
| username | string* | Username of the user to make the card for |
| description | string* | Displayed under the users name |
| avatarUrl | string* | The url of the user’s profile picture |
| backgroundUrl | string | The image of the background (This or backgroundHex is required) |
| backgrundHex | string | The color of the background (This or backgroundUrl is required) |
Response
- 200: OK
- 400: Bad Request
- 401: Unauthorized
- 429: Too Many Requests
{
"url": "http://your-api-link.com/public/card-1707324567890.png",
"created_at": "2026-02-07T17:42:54.000Z"
}
Error
You didn’t provide a valid required field (The body with the * near the type)Check
You didn’t provide a valid required field (The body with the * near the type)Check
response.errorError
You didn’t provide a working apikey.
You didn’t provide a working apikey.
You sent too many requests too quickly. Try again later.
