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
rateLimit
number

Rate limit

Required range: 0 <= x <= 100000000
timeUnit
enum<string>

Per

Available options:
second,
minute,
hour,
day
workers
number

Number of workers

Required range: 1 <= x <= 1000
dailyLimit
number

Daily request limit

Required range: 0 <= x <= 100000000
activeHours
number

Active hours per day

Required range: 1 <= x <= 24
retryAfter
number

Retry-After (seconds)

Required range: 0 <= x <= 86400
requestCount
number

Requests sent before 429

Required range: 0 <= x <= 100000000
timeWindow
number

Time window (seconds)

Required range: 0 <= x <= 86400

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.