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
workloadType
enum<string>

Workload Type

Available options:
web-server,
background-worker,
database,
cache,
ml-inference,
custom
hostCpu
number

Host CPU (cores)

Required range: 1 <= x <= 512
hostRam
number

Host RAM (GB)

Required range: 0.5 <= x <= 4096
containerCount
number

Number of Containers

Required range: 1 <= x <= 100
cpuRequest
number

CPU Request (cores)

Required range: 0.01 <= x <= 512
cpuLimit
number

CPU Limit (cores)

Required range: 0.01 <= x <= 512
memRequest
number

Memory Request (MB)

Required range: 1 <= x <= 4194304
memLimit
number

Memory Limit (MB)

Required range: 1 <= x <= 4194304

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.