Skip to main content

​
Introduction

The Scalekit API is a RESTful API that enables you to manage organizations, users, and authentication settings. All requests must use HTTPS and include proper authentication credentials.

​
Base URLs

Scalekit operates two separate environments with different base URLs: 
https://{your-subdomain}.scalekit.dev
Resources cannot be moved between Development and Production environments. Each environment maintains its own isolated data and configurations.

​
API Versioning

The Scalekit API uses version 1.0.0. All API endpoints are prefixed with /api/v1/ to ensure backward compatibility. Example endpoint structure: 
https://{your-subdomain}.scalekit.dev/api/v1/organizations

​
Request Format

All API requests should include the following headers:
​
Content-Type
string
required
Set to application/json for all requests
​
Authorization
string
required
Bearer token obtained from OAuth 2.0 Client Credentials flow
​
Accept
string
Set to application/json to receive JSON responses

​
Response Format

All successful API responses return JSON with appropriate HTTP status codes:
Status CodeDescription
200/201Success
400Invalid request
401Authentication error
404Resource not found
429Rate limit exceeded
500/501/504Server error

​
Error Response Structure

Error responses include detailed information to help diagnose issues: 
{
  "code": 16,
  "message": "Token empty",
  "details": [
    {
      "@type": "type.googleapis.com/scalekit.v1.errdetails.ErrorInfo",
      "error_code": "UNAUTHENTICATED"
    }
  ]
}

​
SDKs

Scalekit provides official SDKs for multiple programming languages:

Node.js SDK

Install via npm: @scalekit-sdk/node

Python SDK

Install via pip: scalekit-sdk-python

Go SDK

Install via go get: github.com/scalekit-inc/scalekit-sdk-go

Java SDK

Add Maven dependency: com.scalekit:scalekit-sdk-java

​
Next Steps

Authentication

Learn how to authenticate API requests

Rate Limits

Understand API rate limiting policies

Build docs developers (and LLMs) love

Get started for freeTalk to us