Skip to main content
POST
README Badge Generator

Authorizations

Authorization
string
header
required

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

Body

application/json
ioBadgeTemplate
enum<string>

Preset

Available options:
custom,
version,
license,
build,
coverage,
downloads,
stars,
love
ioBadgeLabel
string

Label

ioBadgeMessage
string

Message

ioLabelColor
string

Label Color

ioMessageColorPreset
enum<string>

Message Color

Available options:
#4c1,
#97ca00,
#a4a61d,
#dfb317,
#fe7d37,
#e05d44,
#007ec6,
#9f9f9f,
#464aff,
custom
ioMessageColor
string

Custom Color

ioBadgeStyle
enum<string>

Style

Available options:
flat,
flat-square,
for-the-badge,
plastic

Response

Tool output

tool
string
required
tool_version
string
required

Output-contract version for this tool. Currently "1" for all tools.

outputs
object
required
credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

request_id
string
credits_remaining
integer | null

Credits left in the current monthly allowance, or null when metering is disabled.