Skip to main content
POST
gpu.endpoint.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
name
string
required

Your chosen name, unique within this kind of resource.

Required string length: 1 - 100
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9 ._-]*$
type
enum<string>
required

Request routing mode.

Available options:
queue,
load-balancer
scaling
object
required

How worker count adjusts to traffic.

startCommand
string

Raw container start command; use this or command/entrypoint, not both.

Maximum string length: 8192
image
string

Container image you control.

Required string length: 1 - 1024
command
string[]

Container command in argument form; an empty array clears it.

Maximum array length: 100

One command argument.

Maximum string length: 2048
entrypoint
string[]

Override the image entrypoint; an empty array clears it.

Maximum array length: 100

One entrypoint argument.

Maximum string length: 2048
diskGB
integer

Ephemeral container disk in GB, 1 to 1000.

Required range: 1 <= x <= 1000
environment
object

Environment values, forwarded only; omitted from results and saved ownership data.

ports
string[]

Ports exposed by the container.

Maximum array length: 30

Port number and protocol, such as 8080/http.

Pattern: ^(?:[1-9]\d{0,4})\/(?:http|tcp)$
registryName
string | null

Your registry credential name; null removes it.

Required string length: 1 - 100
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9 ._-]*$
templateName
string

Your serverless template name; applied once, with explicit fields winning.

Required string length: 1 - 100
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9 ._-]*$
gpu
object

GPU worker shape; mutually exclusive with cpu.

cpu
object[]

Eligible CPU shapes, resolved from the hardware catalogue.

Required array length: 1 - 16 elements
regions
enum<string>[]

Placement regions; empty permits any region.

Maximum array length: 7

Continental placement preference.

Available options:
north-america,
south-america,
europe,
asia,
middle-east,
africa,
oceania
volumeNames
string[]

Your network volumes to attach.

Maximum array length: 16

Your chosen name, unique within this kind of resource.

Required string length: 1 - 100
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9 ._-]*$
startupAcceleration
enum<string>

Cold-start acceleration; priority is an explicit costly choice.

Available options:
off,
enabled,
priority
timeoutSeconds
integer

Default execution time limit in seconds.

Required range: 5 <= x <= 3600
workersMin
integer

Always-on workers, 0 to 8. Above zero starts a metered rental.

Required range: 0 <= x <= 8
workersMax
integer

Maximum workers, 0 to 8.

Required range: 0 <= x <= 8
idleSeconds
integer

Idle time before scale-down, 1 to 3600 seconds; unavailable for queued request-count scaling.

Required range: 1 <= x <= 3600

Response

The result

endpointId
any
required

Your endpoint name, used in later calls.

type
enum<string>
required

Request routing mode.

Available options:
queue,
load-balancer
workersMin
integer
required

Configured always-on workers.

Required range: 0 <= x <= 9007199254740991
workersMax
integer
required

Configured maximum workers.

Required range: 0 <= x <= 9007199254740991
timeoutSeconds
number
required

Default execution timeout in seconds.

Required range: x >= 0
scaling
object
required

How worker count adjusts to traffic.

idleSeconds
integer

Idle scale-down delay, when applicable.

Required range: 1 <= x <= 3600
gpuCount
integer

GPUs per worker.

Required range: 1 <= x <= 8
createdAt
string<date-time>

Creation time, ISO 8601.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$