Lorem Ipsum Generator API

Usage Guide

Generate custom Lorem Ipsum text with our powerful API. Here's how to get started:

Basic Usage


                            https://placehold.cloud/l

This will generate 3 paragraphs of Lorem Ipsum text by default.

Parameters

paragraphs: Number of paragraphs (1-100, default: 3)
minWords: Minimum words per paragraph (1-100, default: 5)
maxWords: Maximum words per paragraph (minWords-100, default: 20)
startWithLoremIpsum: Start with "Lorem ipsum" (true/false, default: true)
useCache: Use cached results (true/false, default: false)
format: Output format (json/html/text, default: json)
capitalize: Capitalize first letter of each word (true/false, default: true)
addPunctuation: Add period at end of paragraphs (true/false, default: false)
seed: Seed for random generation (integer, optional)
uniqueWords: Use unique words in each paragraph (true/false, default: false)

Example


                            https://placehold.cloud/l?paragraphs=2&minWords=10&maxWords=15&format=html&capitalize=false&addPunctuation=true

This will generate 2 paragraphs, each containing 10-15 words, in HTML format, without capitalization but with punctuation.

Response Format

The API returns a JSON response with the following structure:

{
    "status": "success",
    "data": [ ... ],  // Array of paragraphs or formatted string
    "metadata": {
        "paragraphs": 3,
        "minWords": 5,
        "maxWords": 20,
        "totalWords": 45,
        "format": "json",
        "seed": 12345
    }
}

Error Handling

If an error occurs, the API will return a JSON response with an error message:

{
    "status": "error",
    "message": "An error occurred: [Error message]"
}

Rate Limiting

The API is rate-limited to 120 requests per minute to ensure fair usage.