FAfal
Compute

List Compute Instances

Changed on

Returns a list of all compute instances belonging to the authenticated user's workspace.

Requirements:

  • Requires compute permissions (extra_permissions.compute = true)

Key Features:

  • View all instances regardless of status
  • Includes instance configuration, region, and current status
  • Paginated results for large instance lists

Common Use Cases:

  • Monitor all active compute resources
  • Check instance status and availability
  • Audit compute resource usage
  • Build compute management dashboards

See fal.ai docs for more details.

Required permissions: compute:instances:read. Key presets that include them: COMPUTE, READONLY, FULL. See key permissions.

get/compute/instances

Request

  • Base URL
    https://api.fal.ai/v1
  • URL
    https://api.fal.ai/v1/compute/instances
  • Auth
    API key in header Authorization

Query parameters

limitinteger

Maximum number of items to return. Actual maximum depends on query type and expansion parameters.

Example:50
cursorstring

Pagination cursor from previous response. Encodes the page number.

Example:Mg==

Response

Successfully retrieved compute instances

next_cursorstring nullable required

Cursor for the next page of results, null if no more pages

has_moreboolean required

Boolean indicating if more results are available (convenience field derived from next_cursor)

Example response

{
  "instances": [
    {
      "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

  • 479db2f9dcd6Revision changes
    • info

      the endpoint scheme security readonlyApiKey was added to the API

    • info

      the endpoint scheme security adminApiKey was removed from the API