API Reference

​

Base URL

https://api.limitly.dev

​

Authentication

Authorization: Bearer lk_1234567890abcdef1234567890abcdef

​

API Versioning

​

Rate Limiting

​

Common Response Format

{
  "data": {
    // Response data
  },
  "count": 1
}

​

Error Responses

{
  "error": "Error message",
  "code": "ERROR_CODE"
}

​

Common Error Codes

​

Endpoints

​

Authentication

• POST /functions/v1/validate - Validate a user request

​

API Keys

• GET /functions/v1/keys - List all API keys
• POST /functions/v1/keys - Create a new API key
• GET /functions/v1/keys/{id} - Get API key details
• PUT /functions/v1/keys/{id} - Update an API key
• DELETE /functions/v1/keys/{id} - Delete an API key
• POST /functions/v1/keys/{id}/regenerate - Regenerate an API key
• GET /functions/v1/keys/{id}/usage - Get API key usage
• GET /functions/v1/keys/{id}/requests - Get API key request history

​

Plans

• GET /functions/v1/plans - List all plans
• POST /functions/v1/plans - Create a new plan
• GET /functions/v1/plans/{id} - Get plan details
• PUT /functions/v1/plans/{id} - Update a plan
• DELETE /functions/v1/plans/{id} - Delete a plan
• GET /functions/v1/plans/{id}/usage - Get plan usage
• GET /functions/v1/plans/{id}/users - Get plan users
• GET /functions/v1/plans/{id}/keys - Get plan API keys

​

Users

• GET /functions/v1/users - List all users
• POST /functions/v1/users - Create a new user
• GET /functions/v1/users/{id} - Get user details
• PUT /functions/v1/users/{id} - Update a user
• DELETE /functions/v1/users/{id} - Delete a user
• GET /functions/v1/users/{id}/usage - Get user usage
• GET /functions/v1/users/{id}/keys - Get user API keys
• GET /functions/v1/users/{id}/requests - Get user request history

​

Data Types

​

API Key Object

{
  "id": "key_123",
  "api_key": "lk_user_abcdef1234567890abcdef1234567890",
  "name": "Production API Key",
  "user_id": 123,
  "plan_id": "plan_456",
  "status": "active",
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z"
}

​

Plan Object

{
  "id": "plan_123",
  "name": "Basic Plan",
  "description": "Plan for basic users",
  "max_requests": 10000,
  "request_period": "month",
  "is_active": true,
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z"
}

​

User Object

{
  "user_id": 123,
  "name": "John Doe",
  "email": "john@example.com",
  "is_disabled": false,
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z"
}

​

Validation Response

{
  "success": true,
  "details": {
    "current_usage": 45,
    "limit": 1000,
    "remaining": 955,
    "reset_time": "2024-02-01T00:00:00Z",
    "plan_name": "Basic Plan"
  }
}

​

Pagination

• page - Page number (default: 1)
• limit - Items per page (default: 10, max: 100)

​

HTTP Status Codes

​

SDKs

• Node.js SDK - JavaScript/TypeScript SDK
• Next.js SDK - Next.js optimized SDK
• Python SDK - Python SDK

​

Support

• Documentation - Complete documentation
• Dashboard - Manage your account
• Contact - Email support

​

Next Steps

• Authentication - Learn how to authenticate
• Request Validation - Validate user requests
• API Key Management - Manage API keys