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
appName
string

Name

shortName
string

Short Name

description
string

Description

lang
string

Lang

dir
enum<string>

Text Direction

Available options:
auto,
ltr,
rtl
startUrl
string

Start URL

scope
string

Scope

id
string

App ID

display
enum<string>

Display Mode

Available options:
standalone,
fullscreen,
minimal-ui,
browser
orientation
enum<string>

Orientation

Available options:
any,
natural,
portrait,
portrait-primary,
portrait-secondary,
landscape,
landscape-primary,
landscape-secondary
themeColor
string

Theme Color

backgroundColor
string

Background Color

iconsPath
string

Icons Base Path

iconFilename
string

Icon Filename Pattern

iconType
enum<string>

Icon MIME Type

Available options:
image/png,
image/svg+xml,
image/webp,
image/jpeg
iconPurpose
enum<string>

Icon Purpose

Available options:
any,
maskable,
any maskable,
monochrome
size72
boolean

Include 72×72

size96
boolean

Include 96×96

size128
boolean

Include 128×128

size144
boolean

Include 144×144

size152
boolean

Include 152×152

size192
boolean

Include 192×192

size384
boolean

Include 384×384

size512
boolean

Include 512×512

categories
string

Categories

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.