How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
The San Francisco Compute Company

The San Francisco Compute Company Instances API

Spin up instances in a capacity to use your available compute.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 10 operations across 6 paths, and defines 49 schemas. It is described by OpenAPI 3.2.0, at version 0.1.0.

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

10 operations 6 paths 49 schemas 1 DELETE4 GET2 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.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 Instances 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 10

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

Instances 10

Spin up instances in a capacity to use your available compute.

POST
/preview/v2/instances
Create instance
create_instance body → 201401403404422500
GET
/preview/v2/instances
List instances
list_instances 13 params → 200401403404422500
PATCH
/preview/v2/instances
Update multiple instances
batch_patch_instances body → 200401403422500
DELETE
/preview/v2/instances/{id}
Delete instance
delete_instance 1 param → 204401403404409500
GET
/preview/v2/instances/{id}
Get instance
fetch_instance 1 param → 200401403404500
PATCH
/preview/v2/instances/{id}
Update instance
update_instance 1 param body → 200400401403404422500
GET
/preview/v2/instances/{id}/logs
Get instance logs
get_instance_logs 7 params → 200401403404422500
POST
/preview/v2/instances/{id}/replace
Replace instance
replace_instance 2 params body → 201400401403404422500
GET
/preview/v2/instances/{id}/ssh
Get instance SSH info
get_instance_ssh 1 param → 200401403404500
POST
/preview/v2/instances/{id}/terminate
Terminate instance
terminate_instance 1 param → 200401403404500

Schemas 49

The contract defines 49 schemas that model the data the API accepts and returns. The most detailed are CreateInstanceRequest (10 properties), InstanceScope (6 properties), InstanceSshInfo (5 properties), InstanceLogChunk (5 properties). Each schema is shown below with its type and property counts.

Name
string
BatchPatchInstanceEntry
object
One entry in a [BatchPatchInstancesRequest]: the instance to patch (id) and the fields to update. prioritylevel is the only field currently patchable here. To…
2 properties 2 required
Tags
object
ListInstancesResponse
object
4 properties 3 required
ResourcePathOrId_ImageId
string
A resource path like 'sfc:image:acme:prod:my-image' or an ID. Resource paths are human-readable but not stable - they change when resources are renamed or move…
PatchInstanceRequest
object
3 properties
ImageSummary
object
2 properties 2 required
NotFoundError
object
1 property 1 required
InstanceSshHostKey
object
2 properties 2 required
UnprocessableEntityError
object
1 property 1 required
InstanceLogsResponse
object
2 properties 2 required
CreateInstanceRequest
object
10 properties 3 required
CapacitySummary
object
2 properties 2 required
InstanceResponse
InstanceScope
object
6 properties 6 required
DeploymentId
string
InstanceStatus
string
awaitingallocation when waiting for compute allocation on its capacity, running once assigned and the physical machine is running (still takes time for the ima…
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…
PoolSummary
object
A pool referenced by id and name.
2 properties 2 required
ForbiddenError
object
1 property 1 required
ResourcePathOrId_FirewallId
string
A resource path like 'sfc:firewall:acme:prod:my-firewall' or an ID. Resource paths are human-readable but not stable - they change when resources are renamed o…
InstanceSkuId
Accepts the canonical prefix below; additional legacy prefixes are aliased for read compatibility. Writes always emit the canonical form.
InstanceManagedBySummary
ConflictError
object
1 property 1 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
WorkspaceId
string
ErrorDetail
object
3 properties 2 required
InternalServerError
object
1 property 1 required
FirewallId
string
UnixEpoch
integer
Unix timestamp.
ReplaceInstanceRequest
object
Request body for POST /v2/instances/{id}/replace. Terminates the target instance and creates a fresh one on the same capacity and SKU, with a new image (and op…
3 properties 1 required
UnauthorizedError
object
1 property 1 required
InstanceLogChunk
object
5 properties 5 required
ImageId
Accepts the canonical prefix below; additional legacy prefixes are aliased for read compatibility. Writes always emit the canonical form.
DeploymentSummary
object
2 properties 2 required
SpotDeploymentId
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.…
InstanceId
Accepts the canonical prefix below; additional legacy prefixes are aliased for read compatibility. Writes always emit the canonical form.
SpotDeploymentSummary
object
2 properties 2 required
InstancesCursor
string
BatchPatchInstancesRequest
object
Request body for PATCH /v2/instances (batch). Each entry in data applies a partial patch to one instance; instances not mentioned are untouched. All entries mu…
1 property 1 required
instanceResourcePath_InstanceId
string
A resource path for a instance resource. Format: sfc:instance: : : .
BatchPatchInstancesResponse
object
Response shape for PATCH /v2/instances (batch). Mirrors the input list — one InstanceResponse per unique id in the request body, reflecting the post-write stat…
2 properties 2 required
InstanceSshInfo
object
5 properties 3 required
PoolId
string
InstanceInclude
string
BadRequestError
object
1 property 1 required
InstancePriority
string
Instance priority — a relative ranking that determines which instances the system prefers to keep running when capacity is constrained. When a capacity's quota…
CapacityId
Accepts the canonical prefix below; additional legacy prefixes are aliased for read compatibility. Writes always emit the canonical form.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

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

The San Francisco Compute Company Account API
AE Profile APIs.io
The San Francisco Compute Company Deployments API
AE Profile APIs.io
The San Francisco Compute Company Feature Flags API
AE Profile APIs.io
The San Francisco Compute Company Images API
AE Profile APIs.io
The San Francisco Compute Company Instance SKU Catalog API
AE Profile APIs.io
The San Francisco Compute Company Instance SKUs API
AE Profile APIs.io
The San Francisco Compute Company Instance Templates API
AE Profile APIs.io
The San Francisco Compute Company Orderbook API
AE Profile APIs.io
The San Francisco Compute Company Orders API
AE Profile APIs.io
The San Francisco Compute Company Pools API
AE Profile APIs.io
The San Francisco Compute Company Procurements API
AE Profile APIs.io
The San Francisco Compute Company Users API
AE Profile APIs.io
#Instances
← Back to T APIs
API Details
ID
the-san-francisco-compute-company:the-san-francisco-compute-company-instances-api
Base URL
https://api.sfcompute.com/preview/v2
Docs
https://docs.sfcompute.com/preview/using-the-api
Provider
The San Francisco Compute Company
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=the-san-francisco-compute-company-instances-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/the-san-francisco-compute-company-instances-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of The San Francisco Compute Company Instances API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.