Butter Ipsum API

Spread the buttery goodness programmatically

✦ ❈ ✦

API Endpoint

GET /api/v1/generate

Query Parameters

Parameter Type Description
count integer Number of units to generate (1-10)
mode string Generation mode: 'paragraph', 'sentence', or 'word'

Example Request

GET /api/v1/generate?count=2&mode=paragraph

Example Response

{
    "text": "Golden butter melts into the fresh croissant...",
    "metadata": {
        "count": 2,
        "mode": "paragraph",
        "timestamp": "2024-12-19T06:48:13Z"
    }
}

Rate Limits

To ensure smooth service for all users, please limit requests to 60 per minute.

Error Codes

Status Description
400 Invalid parameters (count out of range or invalid mode)
500 Server error