API Documentation

RandomKit API allows you to integrate our random data generation tools into your applications.

Drafting structured metadata for your integration guides? Lean on SchemaForge to validate schemas alongside your API payloads.

ℹ️

API Coming Soon

The RandomKit API is currently in development. This page provides a preview of the planned endpoints and features. Sign up below to be notified when the API launches.

Planned Features

🔑

API Key Authentication

Secure API key authentication with rate limiting and usage monitoring.

⚡

High Performance

Fast response times with globally distributed edge computing.

📊

Usage Analytics

Detailed analytics dashboard to track your API usage and costs.

Planned API Endpoints

POST/api/v1/password/generate

Generate secure random passwords

JSON

{
  "length": 16,
  "uppercase": true,
  "lowercase": true,
  "numbers": true,
  "symbols": true,
  "quantity": 10
}

Response:
{
  "passwords": [
    "aB3$xY9mK2pL4qR1",
    "nV7@dW2eF5gH8jK0",
    ...
  ]
}

POST/api/v1/numbers/generate

Generate random numbers with distributions

JSON

{
  "min": 1,
  "max": 100,
  "quantity": 50,
  "distribution": "uniform",
  "decimals": 0
}

Response:
{
  "numbers": [42, 17, 89, 3, 56, ...]
}

POST/api/v1/strings/generate

Generate random strings, UUIDs, and custom formats

JSON

{
  "length": 10,
  "charset": "alphanumeric",
  "quantity": 20
}

Response:
{
  "strings": ["aB3xY9mK2p", "L4qR1nV7dW", ...]
}

POST/api/v1/test-data/generate

Generate realistic test data (names, emails, addresses)

JSON

{
  "type": "users",
  "quantity": 100,
  "fields": ["name", "email", "phone"]
}

Response:
{
  "data": [
    {
      "name": "John Doe",
      "email": "john.doe@example.com",
      "phone": "+1-555-0123"
    },
    ...
  ]
}

Authentication

All API requests will require an API key passed in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Note: API keys will be available when the API launches. Sign up below to be notified.

Response Format

All API responses will return JSON with a consistent structure:

JSON

{
  "success": true,
  "data": { ... },
  "timestamp": "2024-01-01T00:00:00Z"
}

Error responses will include:

JSON

{
  "success": false,
  "error": "Error message here",
  "code": "ERROR_CODE"
}