Installation

Firecase is an API-first platform — there's nothing to install on your machine to use it. All interactions happen through the REST API or one of the official SDKs.

API Access

All you need is an API key. Create one from your dashboard settings or via the API after logging in.

export FIRECASE_API_KEY="fc_live_..."

Every API request requires a Bearer token in the Authorization header:

curl https://api.firecase.ai/instances \
  -H "Authorization: Bearer $FIRECASE_API_KEY"

Python SDK

Install the official Python SDK:

pip install firecase

Basic usage:

from firecase import Firecase

client = Firecase(api_key="fc_live_...")

# Create an instance
instance = client.instances.create(name="my-sandbox")

# Start the VM
client.vms.start(instance.id)

# Execute code
result = client.exec(instance.id, command=["python3", "-c", "print('hello')"])
print(result.stdout)  # "hello\n"

TypeScript / Node.js SDK

Install the official TypeScript SDK:

npm install @firecase/sdk

Basic usage:

import { Firecase } from "@firecase/sdk";

const client = new Firecase({ apiKey: "fc_live_..." });

// Create an instance
const instance = await client.instances.create({ name: "my-sandbox" });

// Start the VM
await client.vms.start(instance.id);

// Execute code
const result = await client.exec(instance.id, {
  command: ["node", "-e", "console.log('hello')"],
});
console.log(result.stdout); // "hello\n"

Base URL

All API requests go to:

https://api.firecase.ai

The API returns JSON responses and accepts JSON request bodies. All timestamps are Unix seconds (UTC).

Authentication Methods

Firecase supports two authentication methods:

API keys are the recommended method for programmatic access. They never expire but can be revoked from the dashboard.

Rate Limits

The API enforces rate limits per API key:

Rate-limited responses return 429 Too Many Requests with a Retry-After header.

Next Steps

• Follow the Quickstart to create your first sandbox
• Learn about Instances and the core data model
• Explore the API Reference for all endpoints