Skip to main content
Create Service

Body

application/json
name
string
required
Pattern: ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$
image
string
required
port
integer
default:8000
Required range: 1 <= x <= 65535
gpus
integer
default:0
Required range: x >= 0
restart_policy
enum<string>
default:always
Available options:
no,
on-failure,
always
command
string | null
script_path
string | null
env
Env · object | null
vendor
enum<string> | null
Available options:
nvidia,
amd
health_check
HealthCheck · object | null

Response

HTTP 201 response

id
string
required
name
string
required
status
enum<string>
required
Available options:
pending,
scheduled,
running,
paused,
completed,
failed,
cancelled,
retrying,
building,
degraded,
restarting,
stopped
gpu_count
integer
required
created_at
string<date-time>
required
manageable
boolean
required
desired_state
string | null
kind
enum<string>
default:service
Available options:
batch,
service,
model,
database
image
string | null
gpu_ids
string[]
restart_policy
string | null
restart_count
integer
default:0
health_check
Health Check · object | null
container_id
string | null
started_at
string<date-time> | null
finished_at
string<date-time> | null
exit_code
integer | null
error_class
enum<string> | null
Available options:
OOM,
GPU_FAIL,
IMAGE_PULL_FAIL,
USER_ERROR,
TIMEOUT,
CONTAINER_FAIL,
MOUNT_MISSING,
GPU_OOM,
PLATFORM_ERROR,
UNKNOWN
error_message
string | null
submitted_via
string
default:cli
endpoint
ServiceEndpointView · object | null
rollback_available
boolean
default:false
build_version
integer | null
last_deploy
Last Deploy · object | null
data_dir_bytes
integer | null
source
Source · object | null