Skip to main content
POST
Stubs

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
objectId
string
imageId
string
stubType
string
name
string
pythonVersion
string
cpu
string<int64>
memory
string<int64>
gpu
string
handler
string
retries
integer<int64>
timeout
string<int64>
keepWarmSeconds
number<float>
workers
integer<int64>
maxPendingTasks
integer<int64>
volumes
object[]
forceCreate
boolean
onStart
string
callbackUrl
string
authorized
boolean
secrets
object[]
autoscaler
object
taskPolicy
object
concurrentRequests
integer<int64>
extra
string
checkpointEnabled
boolean
gpuCount
integer<int64>
onDeploy
string
onDeployStubId
string
entrypoint
string[]
ports
integer<int64>[]
env
string[]
appName
string
pricing
object
inputs
object
outputs
object
tcp
boolean
blockNetwork
boolean
allowList
string[]
dockerEnabled
boolean
pool
object
isService
boolean
serving
object
disks
object[]
allowMarketplace
boolean
checkpointTrigger
object
hostname
string

Hostname to set inside the container.

persistentRoot
object

A durable machine-root disk. The container's entire root filesystem delta lives on a qcow-backed volume mounted at "/", so disk snapshots capture the whole machine state. Shorthand for a DurableDisk with mount_path "/" and the qcow driver.

Response

A successful response.

ok
boolean
stubId
string
errMsg
string
warnMsg
string
capacityStatus
string

Capacity verdict for the requested GPU types, computed at stub creation: "available", "low", or "none". Empty when no check applies (CPU-only workloads, private-pool-only stubs, or pool-selector-bound stubs).

unsupportedGpus
string[]

GPU types from the request that no serverless pool supports.

matchedPrivatePool
string

Name of an existing ready private pool in the workspace that satisfies the GPU request. Set instead of capacity_status "none" so clients can re-issue stub creation targeting this pool.