Skip to main content

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.

This feature is in preview. See “What is Preview?” to learn more.
The Preview API is available at https://api.sfcompute.com/preview/v2. All requests require a Bearer token.

​
Create an API token

sf tokens create my-token
This prints a token starting with sk_live_. Save it somewhere safe - you will not be able to retrieve it again.

​
Grant permissions

Tokens start with no permissions. Grant access to the resources your token needs. 
sf grants create my-token --role owner --workspace my-workspace
See the Quick Start for more on workspaces and roles.

​
Make a request

curl https://api.sfcompute.com/preview/v2/capacities \
  -H "Authorization: Bearer sk_live_..."

​
API reference

The full API reference is available in the sidebar. The reference is auto-generated from our OpenAPI spec and covers all available endpoints, request parameters, and response shapes.