GET /v1/images/welcome-card
Bearer auth

Creates a welcome card for new server members.

Query parameters

  • username string Required
  • memberCount integer

    Member number

  • guildName string

    Server name

  • avatar string(uri)
  • message string

    Custom message

  • accentColor string

    Format should match the following pattern: ^#[0-9A-Fa-f]{6}$.

Responses

  • 200 image/svg+xml

    SVG image
  • 400 application/json

    Bad request - missing or invalid parameters

    Hide response attributes Show response attributes object
    • success boolean
    • error object
      Hide error attributes Show error attributes object
      • message string
      • code string
    • meta object
      Hide meta attribute Show meta attribute object
      • generatedAt string(date-time)
  • 401 application/json

    Unauthorized - invalid or missing API key

    Hide response attributes Show response attributes object
    • success boolean
    • error object
      Hide error attributes Show error attributes object
      • message string
      • code string
    • meta object
      Hide meta attribute Show meta attribute object
      • generatedAt string(date-time)
GET /v1/images/welcome-card 
curl \
 --request GET 'https://api.4mina.app/v1/images/welcome-card?username=string' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
string
Response examples (400) 
{
  "success": false,
  "error": {
    "message": "string",
    "code": "string"
  },
  "meta": {
    "generatedAt": "2025-05-04T09:42:00Z"
  }
}
Response examples (401) 
{
  "success": false,
  "error": {
    "message": "string",
    "code": "string"
  },
  "meta": {
    "generatedAt": "2025-05-04T09:42:00Z"
  }
}