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
fileSize
number
required

File size

Required range: x >= 0
bandwidth
number
required

Bandwidth

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

File size unit

Available options:
B,
KB,
MB,
GB,
TB,
PB
bandwidthUnit
enum<string>

Bandwidth unit

Available options:
bps,
Kbps,
Mbps,
Gbps
protocol
enum<string>

Protocol overhead

Available options:
None,
TCP,
UDP,
HTTP
efficiency
number

Network efficiency %

Required range: 50 <= x <= 100

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.