Create an app

POST /api/apps

Creates a new app. Maximum 10 apps per account.

Request Body

appNamerequired string Display name for the new app 1–200 characters Example: My Weather App

Responses

appId string Unique identifier for the newly created app Example: -NtestApp123

appName string Display name of the app Example: My Weather App

slug string Auto-generated URL slug for the site Example: my-weather-app

errorrequired object

coderequired string Machine-readable error code UNAUTHORIZEDFORBIDDENNOT_FOUNDVALIDATION_FAILEDRATE_LIMITEDSLUG_TAKENSLUG_RESERVEDDOMAIN_IN_USEAPP_LIMIT_REACHEDSUBSCRIPTION_REQUIREDSUBSCRIPTION_EXISTSNO_PAYMENT_METHODNO_ACTIVE_SUBSCRIPTIONNOT_CANCELINGALREADY_CANCELINGSUBSCRIPTION_CANCELINGSAME_PLANCARD_ERRORPAYMENT_ERRORNO_STRIPE_CUSTOMERCERT_CREATION_FAILEDDEPLOY_FAILEDAPI_KEY_LIMIT_REACHEDINVALID_IDEMPOTENCY_KEYIDEMPOTENCY_KEY_REUSEINTERNAL_ERROR

messagerequired string Human-readable error description

docUrl string (uri) Link to relevant API documentation for this error Example: https://orbitkit.io/api/errors/#unauthorized

details object[] Additional validation details (Zod errors)

errorrequired object

messagerequired string Human-readable error description

docUrl string (uri) Link to relevant API documentation for this error Example: https://orbitkit.io/api/errors/#unauthorized

details object[] Additional validation details (Zod errors)

errorrequired object

messagerequired string Human-readable error description

docUrl string (uri) Link to relevant API documentation for this error Example: https://orbitkit.io/api/errors/#unauthorized

details object[] Additional validation details (Zod errors)

errorrequired object

messagerequired string Human-readable error description

docUrl string (uri) Link to relevant API documentation for this error Example: https://orbitkit.io/api/errors/#unauthorized

details object[] Additional validation details (Zod errors)

Language

URL

POST https://api.orbitkit.io/api/apps

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

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

const data = await response.json();
console.log(data);

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")

let body: [String: Any] = ["appName": "My Weather App"]
request.httpBody = try JSONSerialization.data(withJSONObject: body)

let (data, _) = try await URLSession.shared.data(for: request)
let json = try JSONSerialization.jsonObject(with: data)
print(json)

201

{
  "appId": "-NtestApp123",
  "appName": "My Weather App",
  "slug": "my-weather-app"
}

400

{
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "Validation failed",
    "details": [
      {
        "field": "appName",
        "message": "Required"
      }
    ]
  }
}

401

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or expired token",
    "docUrl": "https://orbitkit.io/api/errors/#unauthorized"
  }
}

409

{
  "error": {
    "code": "SLUG_TAKEN",
    "message": "This slug is already in use"
  }
}

429

{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Too many requests",
    "docUrl": "https://orbitkit.io/api/errors/#rate-limited"
  }
}