List Compute Instances
Returns a list of all compute instances belonging to the authenticated user’s workspace.
Requirements:
- Requires compute permissions (extra_permissions.compute = true)
- Authentication required via admin API key
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.
GET
List Compute Instances
Documentation Index
Fetch the complete documentation index at: https://fal.ai/docs/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Admin API key must be prefixed with "Key ", e.g. Authorization: Key YOUR_ADMIN_API_KEY
Query Parameters
Maximum number of items to return. Actual maximum depends on query type and expansion parameters.
Required range:
x >= 1Example:
50
Pagination cursor from previous response. Encodes the page number.
Example:
"Mg=="
Response
Successfully retrieved compute instances
Response containing a list of compute instances with pagination support
Previous
Get Compute InstanceRetrieves 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](https://docs.fal.ai/compute) for more details.
Next
List Compute Instances