---
title: "Turn arbitrary text into a clean, URL-safe slug."
method: POST
path: "/api/v1/slugify"
tags: ["Text Tools"]
---

# Turn arbitrary text into a clean, URL-safe slug.

`POST /api/v1/slugify`

## Request

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

Slugify. Operations: `slugify` — Generate a URL slug from text.

## Request body

- SlugifySlugify: Generate a URL slug from text.
  - `operation` 'slugify', required
  - `input` string: The text to slugify.
  - `options` object
    - `separator` string: Word separator.
    - `lowercase` boolean: Lowercase the result.
    - `strict` boolean: Strip non-ASCII characters.
    - `maxLength` number: Maximum slug length.

## Response `200`

The operation ran.

- object
  - `ok` unknown, required
  - `tool` 'slugify', required
  - `operation` 'slugify', 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)
