Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

The San Francisco Compute Company Pools API

A bucket of owned compute balance over time.

The San Francisco Compute Company Pools API is one of 14 APIs that The San Francisco Compute Company publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Pools. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 8 operations across 4 paths, and defines 37 schemas. It is described by OpenAPI 3.1.0, at version 0.1.0.

Requests are made against a single base URL, https://api.sfcompute.com.

8 operations 4 paths 37 schemas 1 DELETE4 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1.0
Base URL
https://api.sfcompute.com/preview/v2
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

The San Francisco Compute Company Pools API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer_auth). By default, every request must be authenticated.

  • bearer_auth — Create an API token using sf tokens create or at https://sfcompute.com/account/api-keys.

Paths & Operations 8

Across 4 paths, the API surfaces 8 operations — 1 DELETE, 4 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Pools 8

A bucket of owned compute balance over time.

POST
/preview/v2/pool_transfers
Create pool transfer
create_pool_transfer 1 param body → 202401403404422500503
GET
/preview/v2/pool_transfers
List pool transfers
list_pool_transfers 5 params → 200401403422500
GET
/preview/v2/pool_transfers/{id}
Get pool transfer
fetch_pool_transfer 1 param → 200401403404500
POST
/preview/v2/pools
Create pool
create_pool body → 201401403422500
GET
/preview/v2/pools
List pools
list_pools 8 params → 200401403422500
DELETE
/preview/v2/pools/{id}
Delete pool
delete_pool 1 param → 204401403404422500
GET
/preview/v2/pools/{id}
Get pool
fetch_pool 2 params → 200401403404500
PATCH
/preview/v2/pools/{id}
Update pool
update_pool 1 param body → 200401403404422500

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are v2.PoolTransferResponse (9 properties), PoolScope (7 properties), v2.CreatePoolTransferRequest (4 properties), v2.ListPoolTransfersResponse (4 properties). Each schema is shown below with its type and property counts.

InstanceSkuId
Accepts the canonical prefix below; additional legacy prefixes are aliased for read compatibility. Writes always emit the canonical form.
InternalServerError
object
1 property 1 required
DeploymentId
string
Schedule
array
Node count over time, as a list of [startat, endat) time ranges. Example: 5 nodes from t=0 to t=3600 is [{"startat": 0, "endat": 3600, "nodecount": 5}]. starta…
v2.CreatePoolRequest
object
Create a pool to hold compute.
3 properties 1 required
PoolsCursor
string
v2.CreatePoolTransferRequest
object
Transfer some or all of one pool into another.
4 properties 4 required
UnprocessableEntityError
object
1 property 1 required
PoolTransferId
Accepts the canonical prefix below; additional legacy prefixes are aliased for read compatibility. Writes always emit the canonical form.
v2.PoolKind
string
Pool kind determines what operations are allowed on a pool. - Market: User-created pools. - Originating: Provider pools for selling compute. Cannot add compute…
PoolTransfersCursor
string
ErrorDetail
object
3 properties 2 required
WorkspaceId
string
ResourcePathOrId_PoolId
string
A resource path like 'sfc:pool:acme:prod:my-pool' or an ID. Resource paths are human-readable but not stable - they change when resources are renamed or moved.…
ScheduleEntry
object
A [startat, endat) time range with a fixed nodecount. endat is null only on the final entry, marking an unbounded tail.
3 properties 2 required
ProcurementId
string
UnauthorizedError
object
1 property 1 required
ServiceUnavailableError
object
1 property 1 required
PoolId
string
v2.ListPoolTransfersResponse
object
4 properties 3 required
ListPoolsResponse
object
4 properties 3 required
NotFoundError
object
1 property 1 required
PoolResponse
A pool — a container of owned compute allocation over time.
ProcurementSummary
object
2 properties 2 required
v2.PoolTransferStatus
string
Lifecycle status of a pool transfer.
Tags
object
v2.PoolTransferResponse
object
A transfer of compute from one pool (frompool) to another (topool).
9 properties 8 required
Name
string
v2.PatchPoolRequest
object
Update a pool. Omitted fields are left unchanged.
2 properties
InstanceSkuSummary
object
A summary of an instance SKU - its id and human-recognizable alias - embedded on resources that reference a SKU.
3 properties 3 required
ResourcePathOrId_WorkspaceId
string
A resource path like 'sfc:workspace:acme:my-workspace' or an ID. Resource paths are human-readable but not stable - they change when resources are renamed or m…
UnixEpoch
integer
Unix timestamp.
DeploymentSummary
object
2 properties 2 required
AllocationSchedule
object
2 properties 2 required
PoolScope
object
A pool's scope: its identifiers (pool / sfc:pool: forms), owner, workspace, and kind, as the /pools endpoints present it.
7 properties 7 required
poolResourcePath_PoolId
string
A resource path for a pool resource. Format: sfc:pool: : : .
ForbiddenError
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

the-san-francisco-compute-company-pools-api-openapi.yml Raw ↑

Other APIs The San Francisco Compute Company publishes across the network.

The San Francisco Compute Company Account API
The San Francisco Compute Company Deployments API
The San Francisco Compute Company Feature Flags API
The San Francisco Compute Company Images API
The San Francisco Compute Company Instance SKU Catalog API
The San Francisco Compute Company Instance SKUs API
The San Francisco Compute Company Instance Templates API
The San Francisco Compute Company Instances API
The San Francisco Compute Company Orderbook API
The San Francisco Compute Company Orders API
The San Francisco Compute Company Procurements API
The San Francisco Compute Company Users API