API Overview

OrbitKit provides a REST API for programmatic access to all features. You can use the API to create apps, configure sites, manage subscriptions, and deploy — all without the Dashboard.

Base URL

https://api.orbitkit.io/api

Quick example

Here’s how to check your account status:

# Use your API key (see Authentication guide)
API_KEY="your-api-key"

curl -H "Authorization: Bearer $API_KEY" \
     https://api.orbitkit.io/api/status

let url = URL(string: "https://api.orbitkit.io/api/status")!
var request = URLRequest(url: url)
request.setValue("Bearer \(apiKey)", forHTTPHeaderField: "Authorization")

let (data, _) = try await URLSession.shared.data(for: request)
let status = try JSONDecoder().decode(AccountStatus.self, from: data)

const res = await fetch("https://api.orbitkit.io/api/status", {
  headers: { Authorization: `Bearer ${apiKey}` },
});
const status = await res.json();

Response:

{
  "subscription": "active",
  "planType": "monthly",
  "appCount": 2,
  "hasPaymentMethod": true,
  "hasApps": true
}

Authentication

All endpoints require an API key in the Authorization header. See the Authentication guide for details.

Rate limits

When you hit a rate limit, the API returns 429 Too Many Requests.

Response format

All successful responses return JSON. Error responses use a consistent format — see the Error Handling guide.

Resources

Common patterns

Auth header

Every request must include an API key:

Authorization: Bearer <api-key>

See the Authentication guide for details.

Error handling

All errors return a consistent JSON body with a machine-readable code field. See the Error Handling guide for the complete list of error codes and how to handle them.

Request bodies

All POST and PUT endpoints accept JSON. Include Content-Type: application/json with every request that has a body.

Request IDs

Every response includes an X-Request-Id header. Include this when contacting support about a specific request.

Interactive reference

For complete endpoint documentation with request/response schemas, see the interactive API reference.