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

The authenticated account and logged-in user.

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

This API exposes 1 operation across 1 path, and defines 9 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.

1 operations 1 paths 9 schemas 1 GET

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 Account 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 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Account 1

The authenticated account and logged-in user.

GET
/preview/v2/me
Get the authenticated account and logged-in user
getMe → 200401404500

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are UserResponse (7 properties), MeResponse (5 properties), NotFoundError (1 property), InternalServerError (1 property). Each schema is shown below with its type and property counts.

UnauthorizedError
object
1 property 1 required
InternalServerError
object
1 property 1 required
UserId
string
NotFoundError
object
1 property 1 required
UnixEpoch
integer
Unix timestamp.
userResourcePath_UserId
string
A resource path for a user resource. Format: sfc:user: .
UserResponse
object
7 properties 4 required
MeResponse
object
Response body for GET /v2/me: the authenticated account plus, when the caller is a human user, details about the logged-in user that issued the calling token.
5 properties 3 required
EntityType
string
Whether the account is for personal use or a business. Captured once at onboarding and fixed thereafter (write-once).

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

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

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 Procurements API
The San Francisco Compute Company Users API