Api Keys
getCurrent
apiKeys.getCurrent
Verify the configured API key and return its details, including the organization it belongs to
Risk: read
key full type
key full type
organization full type
organization full type
Baremetals
action
baremetals.action
Start, stop, power-cycle, or reboot a bare-metal server
Risk: write
create
baremetals.create
Provision bare-metal GPU servers (billed while they exist)
Risk: write
object[]
Output full type
Output full type
delete
baremetals.delete
Delete a bare-metal server and release its resources
Risk: destructive · Irreversible
get
baremetals.get
Get a bare-metal server by ID
Risk: read
networks full type
networks full type
list
baremetals.list
List bare-metal GPU servers, optionally filtered by data center
Risk: read
object[]
Output full type
Output full type
listProducts
baremetals.listProducts
List bare-metal server products (GPU types and specs) in a data center
Risk: read
object[]
Output full type
Output full type
update
baremetals.update
Rename a bare-metal server
Risk: write
networks full type
networks full type
Chat
createCompletion
chat.createCompletion
Generate a chat completion with an LLM through the OpenAI-compatible API (billed per token)
Risk: write
messages full type
messages full type
tools full type
tools full type
tool_choice full type
tool_choice full type
response_format full type
response_format full type
choices full type
choices full type
usage full type
usage full type
Containers
create
containers.create
Launch GPU container workloads from a template (billed while they run)
Risk: write
envs full type
envs full type
ports full type
ports full type
object[]
Output full type
Output full type
createShell
containers.createShell
Generate a web shell URL path for a running container
Risk: write
delete
containers.delete
Delete a container workload; its local data is lost
Risk: destructive · Irreversible
get
containers.get
Get a container workload by ID, including status and IP addresses
Risk: read
inboundIP full type
inboundIP full type
outboundIP full type
outboundIP full type
publicIP full type
publicIP full type
storages full type
storages full type
envs full type
envs full type
ports full type
ports full type
getLogs
containers.getLogs
Download the logs of a container workload as text
Risk: read
list
containers.list
List container workloads in the organization
Risk: read
object[]
Output full type
Output full type
listProducts
containers.listProducts
List container products (GPU types and specs) in a data center
Risk: read
object[]
Output full type
Output full type
restart
containers.restart
Restart a container workload
Risk: write
update
containers.update
Update a container’s name, template, command, arguments, environment, ports, or SSH keys
Risk: write
envs full type
envs full type
ports full type
ports full type
Elastic Ips
allocate
elasticIps.allocate
Allocate a static public IPv4 address for the organization
Risk: write
object[]
Output full type
Output full type
associate
elasticIps.associate
Attach an elastic IP to a bare-metal server or container
Risk: write
disassociate
elasticIps.disassociate
Detach an elastic IP from its instance
Risk: write
get
elasticIps.get
Get an elastic IP by ID
Risk: read
list
elasticIps.list
List elastic IPs allocated to the organization
Risk: read
object[]
Output full type
Output full type
listProducts
elasticIps.listProducts
List elastic IP products in a data center
Risk: read
object[]
Output full type
Output full type
release
elasticIps.release
Release an elastic IP; the address cannot be reclaimed
Risk: destructive · Irreversible
Firewalls
associate
firewalls.associate
Apply a firewall to bare-metal servers or containers
Risk: write
create
firewalls.create
Create a firewall with inbound rules in a data center
Risk: write
inboundRules full type
inboundRules full type
inboundRules full type
inboundRules full type
delete
firewalls.delete
Delete a firewall
Risk: destructive · Irreversible
disassociate
firewalls.disassociate
Remove a firewall from bare-metal servers or containers
Risk: write
get
firewalls.get
Get a firewall and its rules by ID
Risk: read
inboundRules full type
inboundRules full type
list
firewalls.list
List firewalls, optionally filtered by data center
Risk: read
object[]
Output full type
Output full type
update
firewalls.update
Replace a firewall’s name, description, and inbound rules
Risk: write
inboundRules full type
inboundRules full type
inboundRules full type
inboundRules full type
Idcs
list
idcs.list
List the data centers (IDCs) available for GPU compute resources
Risk: read
idcs full type
idcs full type
Images
get
images.get
Get an OS image by ID
Risk: read
DefaultPartitionTable full type
DefaultPartitionTable full type
list
images.list
List OS images for bare-metal servers, optionally filtered by data center and product
Risk: read
object[]
Output full type
Output full type
Media Models
get
mediaModels.get
Get a media model’s description and the payload parameters its requests accept
Risk: read
parameters full type
parameters full type
list
mediaModels.list
List the video, image, and audio model IDs served by the GMI request queue
Risk: read
Media Requests
create
mediaRequests.create
Queue a video, image, or audio generation request; poll mediaRequests.get for the outcome (billed)
Risk: write
get
mediaRequests.get
Get the status of a queued media request and, once it succeeds, its output file URLs
Risk: read
Models
list
models.list
List the LLMs available on GMI Cloud serverless inference
Risk: read
data full type
data full type
Router
autoroute
router.autoroute
Let the GMI Router pick the best model for a conversation by cost, balance, or quality and return its completion
Risk: write
messages full type
messages full type
message full type
message full type
routing_metadata full type
routing_metadata full type
Sandboxes
connect
sandboxes.connect
Connect to a running sandbox and return its data-plane domain and access token; a timeout extends its lifetime
Risk: write
data full type
data full type
create
sandboxes.create
Create a sandbox from a template; returns the data-plane host and access token used by sandboxExec and sandboxFiles
Risk: write
data full type
data full type
delete
sandboxes.delete
Kill a sandbox; it moves to deleting and then deleted once resources are released
Risk: destructive · Irreversible
data full type
data full type
get
sandboxes.get
Get sandbox details, including state, resources, and failure reason
Risk: read
data full type
data full type
list
sandboxes.list
List active sandboxes (provisioning, running, updating, checkpointing, failed) with pagination
Risk: read
items full type
items full type
setTimeout
sandboxes.setTimeout
Reset a running sandbox’s time-to-live relative to now (300 seconds when omitted)
Risk: write
data full type
data full type
updateMetadata
sandboxes.updateMetadata
Replace a sandbox’s metadata as a whole (an empty object clears it)
Risk: write
data full type
data full type
Sandbox Exec
cancel
sandboxExec.cancel
Cancel a running sandbox command
Risk: write
object
Output full type
Output full type
get
sandboxExec.get
Get the status, exit code, and output of a sandbox command
Risk: read
run
sandboxExec.run
Run a shell command inside a sandbox; with wait it returns the result, otherwise poll sandboxExec.get
Risk: write
parameters full type
parameters full type
object
Output full type
Output full type
Sandbox Files
download
sandboxFiles.download
Download a file from a sandbox by absolute path. On Corsair up to about 700 KB comes back inline as contentBase64 and a larger file comes back as fileId, a Files id; without a host that keeps files the content comes back inline up to 100 MB, or contentOmitted beyond it.
Risk: read
upload
sandboxFiles.upload
Write a file to an absolute path inside a sandbox, overwriting any existing file
Risk: write
object[]
Output full type
Output full type
Sandbox Products
list
sandboxProducts.list
List the sandbox product catalog (CPU, memory, disk) in a data center
Risk: read
data full type
data full type
Sandbox Templates
create
sandboxTemplates.create
Create a sandbox template from an image or another template and start its first build
Risk: write
resources full type
resources full type
build full type
build full type
data full type
data full type
delete
sandboxTemplates.delete
Delete a sandbox template; existing sandboxes keep running
Risk: destructive · Irreversible
data full type
data full type
get
sandboxTemplates.get
Get a sandbox template with its current and latest build
Risk: read
data full type
data full type
getBuild
sandboxTemplates.getBuild
Get a sandbox template build status and artifact availability
Risk: read
data full type
data full type
getBuildLogs
sandboxTemplates.getBuildLogs
Get build logs for a sandbox template build, paged by offset
Risk: read
data full type
data full type
list
sandboxTemplates.list
List sandbox templates with pagination
Risk: read
items full type
items full type
listBuilds
sandboxTemplates.listBuilds
List the builds of a sandbox template, newest first, with pagination
Risk: read
items full type
items full type
update
sandboxTemplates.update
Update a sandbox template’s name, description, or labels
Risk: write
data full type
data full type
Templates
create
templates.create
Create a custom container template
Risk: write
credential full type
credential full type
delete
templates.delete
Delete a custom container template
Risk: destructive · Irreversible
get
templates.get
Get a container template by ID
Risk: read
credential full type
credential full type
list
templates.list
List container templates (official and custom) used to launch containers
Risk: read
object[]
Output full type
Output full type
update
templates.update
Update a custom container template
Risk: write
credential full type
credential full type
Uploads
createUrl
uploads.createUrl
Get a pre-signed upload URL and the stable public URL to reference an image, video, or audio file in media requests
Risk: write
Vpcs
allocate
vpcs.allocate
Allocate the default VPC for the organization in a data center
Risk: write
subnets full type
subnets full type
get
vpcs.get
Get a VPC and its subnets by ID
Risk: read
subnets full type
subnets full type
list
vpcs.list
List VPCs, optionally filtered by data center
Risk: read
object[]
Output full type
Output full type
release
vpcs.release
Release the default VPC
Risk: destructive · Irreversible