Compute

Create Compute Instance

Creates a new compute instance with the specified configuration and SSH key.

Requirements:

  • Requires compute permissions (extra_permissions.compute = true)
  • Authentication required via admin API key
  • Valid SSH public key required for instance access

Key Features:

  • Create high-performance GPU instances
  • Specify sector for InfiniBand configuration (8x H100 only)
  • SSH key-based authentication
  • Automatic instance provisioning and region assignment
  • Idempotent creation with Idempotency-Key header (optional but recommended)

Common Use Cases:

  • Spin up compute resources for ML training
  • Create GPU instances for inference workloads
  • Set up development environments with H100 GPUs
  • Deploy distributed training with InfiniBand networking

Instance Types:

  • gpu_8x_h100_sxm5: 8x NVIDIA H100 GPUs (high-performance, supports sector configuration for InfiniBand)
  • gpu_1x_h100_sxm5: 1x NVIDIA H100 GPU (standard)

Idempotency:

  • Optional Idempotency-Key header prevents duplicate instance creation on retries
  • Responses cached for 10 minutes per unique key

See fal.ai docs for more details.

post/compute/instances

Headers

Idempotency-Keystring

Optional idempotency key for safe request retries

Example:550e8400-e29b-41d4-a716-446655440000

Optional idempotency key for safe request retries

Request body

instance_type'gpu_8x_h100_sxm5' | 'gpu_1x_h100_sxm5' required

Type of compute instance to create

ssh_keystring required

SSH public key for accessing the instance (e.g., 'ssh-rsa AAAAB3...')

sector'sector_1' | 'sector_2' | 'sector_3'

Sector for InfiniBand configuration (only valid with gpu_8x_h100_sxm5)

Example request

{
  "instance_type": "gpu_1x_h100_sxm5",
  "ssh_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQC... user@host",
  "sector": "sector_1"
}

Response

Compute instance created successfully

idstring required

Unique identifier for the compute instance

instance_type'gpu_8x_h100_sxm5' | 'gpu_1x_h100_sxm5' required

Type of compute instance (GPU configuration)

region'us-west' | 'us-central' | 'us-east' | 'eu-north' | 'eu-west' | 'other' required

Geographical region where the instance is located

sector'sector_1' | 'sector_2' | 'sector_3'

Sector identifier for instance placement within the region (if applicable)

ipstring

IP address of the instance (available when instance is ready)

status'ready' | 'init' | 'pending' | 'provisioning' | 'stopped' | 'unknown' required

Current operational status of the instance

creator_user_nicknamestring

Nickname of the user who created this instance

Example response

{
  "id": "inst_abc123xyz",
  "instance_type": "gpu_1x_h100_sxm5",
  "region": "us-west",
  "sector": "sector_1",
  "ip": "203.0.113.42",
  "status": "ready",
  "creator_user_nickname": "developer"
}

Changes

No recorded changes to this endpoint across all 2 revisions of this API.