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 Procurements API

Market automations that maintain capacity by placing buy/sell orders.

The San Francisco Compute Company Procurements 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 Procurements. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 5 operations across 2 paths, and defines 32 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.

5 operations 2 paths 32 schemas 1 DELETE2 GET1 PATCH1 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 Procurements 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 5

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

Procurements 5

Market automations that maintain capacity by placing buy/sell orders.

POST
/preview/v2/procurements
Create procurement
create_procurement body → 201400401403409422500
GET
/preview/v2/procurements
List procurements
list_procurements 5 params → 200401403422500
DELETE
/preview/v2/procurements/{id}
Delete procurement
delete_procurement 1 param → 204401403404500
GET
/preview/v2/procurements/{id}
Get procurement
get_procurement 1 param → 200401403404500
PATCH
/preview/v2/procurements/{id}
Update procurement
patch_procurement 1 param body → 200400401403404422500

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are CreateProcurementRequest (8 properties), PatchProcurementRequest (6 properties), ProcurementScope (6 properties), ListProcurementsResponse (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
ProcurementScope
object
6 properties 6 required
UnprocessableEntityError
object
1 property 1 required
AutomationStatus
string
ProcurementsCursor
string
ErrorDetail
object
3 properties 2 required
WorkspaceId
string
ConflictError
object
1 property 1 required
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.…
BadRequestError
object
1 property 1 required
ProcurementId
string
UnauthorizedError
object
1 property 1 required
ProcurementResponse
procurementResourcePath_ProcurementId
string
A resource path for a procurement resource. Format: sfc:procurement: : : .
PoolId
string
ReconciliationStatus
object
2 properties 2 required
NotFoundError
object
1 property 1 required
PoolSummary
object
A pool referenced by id and name.
2 properties 2 required
NodeCountTag
string
CapacityId
Accepts the canonical prefix below; additional legacy prefixes are aliased for read compatibility. Writes always emit the canonical form.
Name
string
ProcurementTarget
CapacitySummary
object
2 properties 2 required
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
DollarsPerNodeHour
string
Price rate in dollars per node-hour.
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…
CreateProcurementRequest
object
8 properties 6 required
UnixEpoch
integer
Unix timestamp.
ListProcurementsResponse
object
4 properties 3 required
PatchProcurementRequest
object
6 properties
ForbiddenError
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

the-san-francisco-compute-company-procurements-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 Pools API
The San Francisco Compute Company Users API