---
title: "Generate placeholder text in several styles."
method: POST
path: "/api/v1/lorem"
tags: ["Text Tools"]
---

# Generate placeholder text in several styles.

`POST /api/v1/lorem`

## Request

- Base URL: `https://programmes.net`
- URL: `https://programmes.net/api/v1/lorem`
- Auth: none declared

Lorem Ipsum Generator. Operations: `generate` — Generate lorem ipsum (or themed) placeholder text.

## Request body

- LoremGenerate: Generate lorem ipsum (or themed) placeholder text.
  - `operation` 'generate', required
  - `input` string: Unused (pass an empty string).
  - `options` object
    - `count` integer: Number of units to generate.
    - `unitType` 'paragraphs' | 'sentences' | 'words': What to count.
    - `generatorType` 'lorem' | 'hipster' | 'bacon' | 'corporate' | 'pirate' | 'zombie': Word theme.
    - `startWithLorem` boolean: Start with the classic "Lorem ipsum".
    - `customWords` string: Comma- or space-separated words to use instead of the theme.
    - `includeNumbers` boolean: Mix numbers into the text.
    - `includeSpecialChars` boolean: Mix punctuation and symbols into the text.

## Response `200`

The operation ran.

- object
  - `ok` unknown, required
  - `tool` 'lorem', required
  - `operation` 'generate', required
  - `result` unknown, required

## Other responses

- `400`: The request is not valid (https://programmes.net/api#invalid-request); The tool has no such operation (https://programmes.net/api#unknown-operation)
- `404`: No such tool (https://programmes.net/api#unknown-tool)
- `413`: The request or its input is too large (https://programmes.net/api#content-too-large)
- `415`: The body must be JSON (https://programmes.net/api#unsupported-media-type)
- `422`: An option is missing, of the wrong type or out of range (https://programmes.net/api#invalid-options); This call needs more CPU than one API call may use (https://programmes.net/api#refused); The operation could not process the input (https://programmes.net/api#tool-error)
- `429`: Too many requests (https://programmes.net/api#rate-limited)
- `500`: Internal error (https://programmes.net/api#internal-error)

---

[API](https://skmtc.dev/programmes/apis/programmes-net-api.md) · [All operations](https://skmtc.dev/programmes/apis/programmes-net-api/llms.txt) · [OpenAPI document](https://skmtc.dev/programmes/apis/programmes-net-api/revisions/aa939784a2e6?raw)