Sign in
Compute

Get Compute Instance

Retrieves detailed information about a specific compute instance by its ID.

Requirements:

  • Requires compute permissions (extra_permissions.compute = true)
  • Authentication required via admin API key
  • Instance must belong to the authenticated user's workspace

Key Features:

  • Get current instance status and configuration
  • Access instance IP address when available
  • View region and sector placement
  • Check creator information

Common Use Cases:

  • Monitor specific instance status
  • Retrieve connection details (IP address)
  • Check instance readiness before use
  • Audit instance configuration

See fal.ai docs for more details.

get/compute/instances/{id}

Path parameters

idstring required

Unique identifier for the compute instance

Example:inst_abc123xyz

Unique identifier for the compute instance

Response

Successfully retrieved compute instance details

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.