> ## Documentation Index
> Fetch the complete documentation index at: https://docs.unrealapi.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Card

`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

<Tabs>
  <Tab title="200: OK">
    ```json theme={null}
      {
        "url": "http://your-api-link.com/public/card-1707324567890.png",
        "created_at": "2026-02-07T17:42:54.000Z"
      }
    ```
  </Tab>

  <Tab title="400: Bad Request">
    **Error**\
    You didn't provide a valid required field
    (The body with the \* near the type)

    Check `response.error`
  </Tab>

  <Tab title="401: Unauthorized">
    **Error**\
    You didn't provide a working apikey.
  </Tab>

  <Tab title="429: Too Many Requests">
    You sent too many requests too quickly. Try again later.
  </Tab>
</Tabs>