Documentation

Quickstart

Make your first OrbitKit API request in under 5 minutes.

Get up and running with the OrbitKit API in minutes. By the end of this guide, you’ll have made your first authenticated API request.

Prerequisites

  • An OrbitKit account (sign up at orbitkit.io)
  • A tool for making HTTP requests (curl, Postman, or your language’s HTTP client)

1. Create an API key

The fastest way to authenticate is with an API key:

  1. Log in to the Account page
  2. Scroll to API Keys and click Create API Key
  3. Give it a name (e.g., “Development”) and copy the key

The key looks like ok_BRTRKFsL_51FwqftsmMDHHbJAMEXXHCgG. Store it securely — it’s only shown once.

2. Make your first request

Check your account status with a simple GET request:

API_KEY="ok_your_key_here"

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();

3. Read the response

You’ll get a JSON response like this:

{
  "subscription": "none",
  "planType": null,
  "appCount": 0,
  "hasPaymentMethod": false,
  "hasApps": false
}

This tells you your account’s current state — how many apps you have, your subscription status, and whether a payment method is on file.

4. Try creating an app

Now create your first app:

curl -X POST https://api.orbitkit.io/api/apps \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"appName": "My Test App"}'

var request = URLRequest(url: URL(string: "https://api.orbitkit.io/api/apps")!)
request.httpMethod = "POST"
request.setValue("Bearer \(apiKey)", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
request.httpBody = try JSONEncoder().encode(["appName": "My Test App"])

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

const res = await fetch("https://api.orbitkit.io/api/apps", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${apiKey}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ appName: "My Test App" }),
});
const app = await res.json();

The response includes the new appId — you’ll use this for all subsequent operations on this app.

What’s next