Quick Start

Developer Documentation

Integrate Shulker's infrastructure APIs into your applications. High-performance storage, monitoring, and AI services — all under one platform.

Updated 3 days ago 4.2k monthly reads 8 min read

Quick Example

Store an object

POST /v1/sdx
curl -X POST https://shulker.in/api/sdx \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "key": "user_config",
    "data": {"theme": "dark"}
  }'
200 OK · 24ms
{"status":"success","id":"sdx_8923472"}

Retrieve an object

GET /v1/sdx/:key
curl https://shulker.in/api/sdx/user_config \
  -H "Authorization: Bearer sk_live_..."
200 OK · 18ms
{"key":"user_config","data":{"theme":"dark"}}

Need an API key? Generate test and production keys via the dashboard, or contact the team for access. Test keys are rate-limited to 100 req/min.

Request Parameters

SDX Storage — POST /v1/sdx

Parameter Type Required Description
key string Required Unique identifier. Max 256 chars, alphanumeric + underscores.
data object Required Payload to store. JSON object, binary, or raw string. Max 5MB.
ttl integer Optional Time-to-live in seconds. Object auto-deletes after expiry. Default: no expiry.
namespace string Optional Logical grouping for keys. Useful for multi-tenant apps. Default: default.

Authentication

All API requests require a Bearer token in the Authorization header. Use sk_test_ prefixed keys for development and sk_live_ for production. Keys are scoped per service — an SDX key cannot access Supervisor endpoints.

Never expose your sk_live_ key in client-side code or public repositories. Rotate compromised keys immediately from the key management dashboard.

Error Codes

401 Unauthorized
Missing or invalid Bearer token.
403 Forbidden
Token lacks permission for this resource or endpoint.
404 Not Found
Key doesn't exist in the specified namespace.
429 Rate Limited
Exceeded limit. Retry after Retry-After header.
413 Payload Too Large
Object exceeds the 5MB limit per key.
500 Server Error
Internal error. Check the status page.