Skip to main content
POST

Authorizations

Authorization
string
header
required

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

Body

application/json
sigFullName
string

Full name

sigJobTitle
string

Job title

sigCompany
string

Company

sigPhone
string

Phone

sigEmail
string

Email

sigWebsite
string

Website

sigAddress
string

Address

sigLayout
enum<string>

Layout

Available options:
horizontal,
vertical,
compact
sigFont
enum<string>

Font family

Available options:
system,
helvetica,
georgia,
courier
sigAccentColor
string

Accent colour

sigTextColor
string

Text colour

sigFontSize
enum<string>

Font size

Available options:
12,
13,
14
sigPhotoEnabled
boolean

Include profile photo

sigPhotoUrl
string

Photo URL

sigPhotoShape
enum<string>

Photo shape

Available options:
circle,
rounded,
square
sigLogoEnabled
boolean

Include company logo

sigLogoUrl
string

Logo URL

sigLinkedinUrl
string

LinkedIn URL

sigTwitterUrl
string

Twitter / X URL

sigGithubUrl
string

GitHub URL

sigInstagramUrl
string

Instagram URL

sigDisclaimerEnabled
boolean

Include disclaimer / legal note

sigDisclaimerText
string

Disclaimer text

Response

Tool output

outputs
object
required
tool
string
required

The tool's slug, echoing the {slug} in the request path.

tool_version
string
required

Output-contract version for this tool.

credits_used
integer
required

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

credits_remaining
integer | null
required

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

request_id
string

Correlation id, also sent as x-request-id.