Skip to main content
POST
Generate a Badge Image

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Badge ID in this school.

Required string length: 1 - 255

Body

prompt
string

Omitted or blank uses the badge name. Null is rejected.

Maximum string length: 10000
style
string

emoji, minimalistic_2d, stylized_3d or realistic. Omitted, blank or unrecognized values use emoji. Null is rejected.

Maximum string length: 10000

Response

Successful response.

id
string
required
status
enum<string>
required
Available options:
queued