API Overview

Game Framework provides a comprehensive REST API for programmatic access.

Base URL

https://registry.yourcompany.com/v1

Authentication

All API requests require authentication:

curl https://registry.yourcompany.com/v1/packages \
  -H "Authorization: Bearer YOUR_TOKEN"

Token Types

User tokens - For development (24h expiry)
API keys - For automation (custom expiry)

See Authentication.

API Endpoints

Workspaces

GET    /v1/workspaces
POST   /v1/workspaces
GET    /v1/workspaces/:id
PATCH  /v1/workspaces/:id
DELETE /v1/workspaces/:id

Packages

GET    /v1/workspaces/:workspaceId/packages
POST   /v1/workspaces/:workspaceId/packages
GET    /v1/packages/:id
PATCH  /v1/packages/:id
DELETE /v1/packages/:id

Versions

GET    /v1/packages/:packageId/versions
POST   /v1/packages/:packageId/versions
GET    /v1/versions/:id
DELETE /v1/versions/:id

See API Endpoints for details.

Response Format

Success Response

{
  "id": "pkg_c0s6t7vjnb0c73f5g6eg",
  "name": "my_package",
  "version": "1.0.0",
  "created_at": "2025-01-10T10:00:00Z"
}

Error Response

{
  "error": {
    "code": "unauthorized",
    "message": "Authentication required",
    "details": {}
  }
}

Pagination

List endpoints support pagination:

curl "https://registry.yourcompany.com/v1/packages?limit=50&offset=0" \
  -H "Authorization: Bearer $TOKEN"

Response:

{
  "items": [...],
  "total": 125,
  "limit": 50,
  "offset": 0
}

Rate Limiting

Plan	Rate Limit
Free	100 requests/hour
Pro	1000 requests/hour
Enterprise	10000 requests/hour

Headers:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1704988800

Next Steps

Authentication - Auth methods
Rate Limiting - Limits and throttling
Error Codes - HTTP status codes
Endpoints - API endpoints

On this page