Skip to main content
GET
/
compute
/
instances
/
{id}
Get Compute Instance
curl --request GET \
  --url https://api.fal.ai/v1/compute/instances/{id} \
  --header 'Authorization: <api-key>'
{
  "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"
}

Authorizations

​
Authorization
string
header
required

Admin API key must be prefixed with "Key ", e.g. Authorization: Key YOUR_ADMIN_API_KEY

Path Parameters

​
id
string
required

Unique identifier for the compute instance

Minimum length: 1
Example:

"inst_abc123xyz"

Response

Successfully retrieved compute instance details

Compute instance details including configuration, location, and status

​
id
string
required

Unique identifier for the compute instance

Example:

"inst_abc123xyz"

​
instance_type
enum<string>
required

Type of compute instance (GPU configuration)

Available options:
gpu_8x_h100_sxm5,
gpu_1x_h100_sxm5
Example:

"gpu_1x_h100_sxm5"

​
region
enum<string>
required

Geographical region where the instance is located

Available options:
us-west,
us-central,
us-east,
eu-north,
eu-west,
other
Example:

"us-west"

​
status
enum<string>
required

Current operational status of the instance

Available options:
ready,
init,
pending,
provisioning,
stopped,
unknown
Example:

"ready"

​
sector
enum<string>

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

Available options:
sector_1,
sector_2,
sector_3
Example:

"sector_1"

​
ip
string

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

Example:

"203.0.113.42"

​
creator_user_nickname
string

Nickname of the user who created this instance

Example:

"developer"