> ## Documentation Index > Fetch the complete documentation index at: https://docs.sfcompute.com/llms.txt > Use this file to discover all available pages before exploring further. # List grouped instance-SKU availability > > ⚠️ This endpoint is in [public preview](/preview/roadmap). Aggregate availability across instance SKUs that match `requirements`, grouped by the given property keys. Each group exposes a summed `total` schedule plus a per-SKU breakdown. ## OpenAPI ````yaml /preview/openapi.json get /preview/v2/availability openapi: 3.1.0 info: title: sfc-api description: >- Public preview API - subject to change. See https://docs.sfcompute.com/preview/roadmap for details. version: 0.1.0 servers: - url: https://api.sfcompute.com security: - bearer_auth: [] tags: - name: Pools description: A bucket of owned compute balance over time. - name: Orders description: >- Place orders targeting a capacity to increase your reserved compute balance during some time period. - name: Instance Templates description: Reusable instance configuration. - name: Images description: Custom machine images for instances. - name: Roles description: TOML-based permission role definitions. - name: Grants description: Bind principals (users or tokens) to roles on a workspace. - name: Tokens description: Workspace-scoped API tokens. - name: Instances description: Spin up instances in a capacity to use your available compute. - name: Instance SKU Catalog description: Browse available instance SKU property definitions. - name: Procurements description: Market automations that maintain capacity by placing buy/sell orders. - name: Deployments description: Deployment automations that maintain a fleet of instances on a capacity. - name: Users description: Read-only access to users within the caller's organization. - name: Workspaces description: Resource containers scoped to an account. - name: Permissions description: Inspect what the caller is allowed to do. - name: Billing description: Billing profile, contacts, and auto top-up settings. - name: Orderbook description: >- Read-only orderbook visibility: bid/ask spread, depth of book, and historical fills, keyed on hardware requirements + delivery window. - name: Orders description: >- Estimate an order before placing it: filled price, fee, and operational notices. paths: /preview/v2/availability: get: tags: - Instance SKUs summary: List grouped instance-SKU availability description: >- > ⚠️ This endpoint is in [public preview](/preview/roadmap). Aggregate availability across instance SKUs that match `requirements`, grouped by the given property keys. Each group exposes a summed `total` schedule plus a per-SKU breakdown. operationId: list_availability parameters: - name: requirements in: query description: >- Filter SKUs before grouping. Semicolon-separated `key:value[,value...]` pairs (e.g. `accelerator:H100`). Use keys and values from `/v2/instance_sku_property_catalog`. required: false schema: type: string - name: group_by in: query description: >- Property keys to group by. Repeatable: `?group_by=accelerator`. Each key must be a public registry key. Empty `group_by` → a single aggregate group. required: false schema: type: array items: $ref: '#/components/schemas/Name' style: form explode: true responses: '200': description: Grouped availability schedules. content: application/json: schema: $ref: '#/components/schemas/ListAvailabilityResponse' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' '422': description: Validation failed. content: application/json: schema: $ref: '#/components/schemas/UnprocessableEntityError' '500': description: Internal server error. content: application/json: schema: $ref: '#/components/schemas/InternalServerError' security: - bearer_auth: [] components: schemas: Name: type: string examples: - my-resource-name maxLength: 255 minLength: 1 pattern: '[a-zA-Z0-9][a-zA-Z0-9._-]{0,254}' ListAvailabilityResponse: type: object required: - object - data properties: object: type: string const: list default: list readOnly: true data: type: array items: $ref: '#/components/schemas/AvailabilityGroup' UnauthorizedError: type: object required: - error properties: error: type: object required: - type - message properties: type: type: string const: authentication_error default: authentication_error readOnly: true message: type: string x-speakeasy-error-message: true UnprocessableEntityError: type: object required: - error properties: error: type: object required: - type - message properties: type: type: string const: unprocessable_entity default: unprocessable_entity readOnly: true message: type: string x-speakeasy-error-message: true details: type: array items: $ref: '#/components/schemas/ErrorDetail' InternalServerError: type: object required: - error properties: error: type: object required: - type - message properties: type: type: string const: api_error default: api_error readOnly: true message: type: string x-speakeasy-error-message: true AvailabilityGroup: type: object description: >- One row of `GET /v2/availability` — the SKUs that share the requested group key, with their summed and per-SKU allocation schedules. required: - group - allocation_schedule properties: group: type: array items: $ref: '#/components/schemas/InstanceSkuProperty' description: >- Values of the `group_by` keys that define this group, in the same order as the request's `group_by`. Empty when no `group_by` was passed (single-aggregate case). Properties are projected with the same public-key/value rules as `GET /v2/instance_skus`. allocation_schedule: $ref: '#/components/schemas/AllocationSchedule' description: >- `total` = sum of `available_for_purchase_shape` across every SKU in the group; `by_instance_sku` = each SKU's own shape, unsummed. ErrorDetail: type: object required: - code - message properties: field: type: - string - 'null' description: The field that caused the error (for validation errors) code: type: string description: Specific error code for this detail message: type: string description: Human-readable error message InstanceSkuProperty: oneOf: - type: object required: - key - value - type properties: key: $ref: '#/components/schemas/InstanceSkuPropertyKey' value: $ref: '#/components/schemas/InstanceSkuEnumerationValue' type: type: string const: enumeration default: enumeration readOnly: true description: >- A property set on an instance SKU. Tagged by `type` so new value kinds can be added without breaking clients. AllocationSchedule: type: object required: - total - by_instance_sku properties: total: $ref: '#/components/schemas/Schedule' description: >- Combined allocation schedule across all instance SKUs. Only includes current and future schedule. by_instance_sku: type: object description: >- Allocation schedule keyed by instance SKU. Only includes current and future schedule. additionalProperties: $ref: '#/components/schemas/Schedule' propertyNames: oneOf: - type: string examples: - isku_k3R-nX9vLm7Qp2Yw5Jd8F pattern: isku_[0-9a-zA-Z_-]{1,21} - type: string description: Legacy alias prefix; accepted on read, never emitted on write. pattern: clus_[0-9a-zA-Z_-]{1,21} description: >- Accepts the canonical prefix below; additional legacy prefixes are aliased for read compatibility. Writes always emit the canonical form. InstanceSkuPropertyKey: type: object description: >- A property key describing something about an instance SKU (e.g. `accelerator`). required: - name - display_name - description - stable_at properties: name: $ref: '#/components/schemas/Name' display_name: type: string description: Human-readable display name. description: type: string documentation_link: type: - string - 'null' description: Link to a spec sheet or further documentation. stable_at: $ref: '#/components/schemas/UnixEpoch' deprecated_at: oneOf: - type: 'null' - $ref: '#/components/schemas/UnixEpoch' deprecation_info: type: - string - 'null' description: Migration guidance shown when the key is deprecated. InstanceSkuEnumerationValue: type: object description: One allowed value for an enumeration-typed property key. required: - name - display_name - description - stable_at properties: name: $ref: '#/components/schemas/Name' display_name: type: string description: Human-readable display name. description: type: string documentation_link: type: - string - 'null' stable_at: $ref: '#/components/schemas/UnixEpoch' deprecated_at: oneOf: - type: 'null' - $ref: '#/components/schemas/UnixEpoch' deprecation_info: type: - string - 'null' description: Migration guidance shown when the value is deprecated. Schedule: type: array items: $ref: '#/components/schemas/ScheduleEntry' description: >- Node count over time, as a list of `[start_at, end_at)` time ranges. Example: 5 nodes from t=0 to t=3600 is `[{"start_at": 0, "end_at": 3600, "node_count": 5}]`. `start_at` and `end_at` must be 60-second aligned, `node_count` must be non-negative. On non-final entries, `end_at` may be omitted (inferred from the next entry's `start_at`); gaps fill with `node_count: 0`. UnixEpoch: type: integer format: int64 description: Unix timestamp. example: 1738972800 ScheduleEntry: type: object description: >- A `[start_at, end_at)` time range with a fixed `node_count`. `end_at` is `null` only on the final entry, marking an unbounded tail. required: - start_at - node_count properties: start_at: $ref: '#/components/schemas/UnixEpoch' end_at: oneOf: - type: 'null' - $ref: '#/components/schemas/UnixEpoch' node_count: type: integer format: int32 securitySchemes: bearer_auth: type: http scheme: bearer bearerFormat: JWT description: >- Create an API token using `sf tokens create` or at https://sfcompute.com/account/api-keys. ````