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
startTime
string
required

Start time

totalUnits
number
required

Total units

Required range: x >= 1
perNumber
number
required

A unit finished every

Required range: x >= 1
perUnit
enum<string>

Pace unit

Available options:
ms,
s,
m,
h,
d,
w,
mo,
y
breakTime
number

Break time

Required range: x >= 0
breakTimeUnit
enum<string>

Break time unit

Available options:
ms,
s,
m,
h,
d,
w,
mo,
y
bufferTimePercentage
number

Buffer time %

Required range: x >= 0
workingHoursOnly
boolean

Working hours only (9am-5pm)

excludeWeekends
boolean

Exclude weekends (Sat & Sun)

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.