POST /v1/core/slugify

Slugify

Accents flattened, punctuation dropped, spaces hyphenated — the form a URL will accept without escaping.

Turn a title into a URL slug now No key, no code — 1 credit either way.

curl -X POST "$DOATHING_API/v1/core/slugify" \
  -H "x-api-key: $DOATHING_KEY" \
  -H "content-type: application/json" \
  -d '{"text": "Crème Brûlée: a Recipe!"}'

Accents flattened, punctuation dropped, spaces hyphenated — the form a URL will accept without escaping.

Transliterate any string to a lowercase ASCII URL slug with a configurable separator and length cap.

Input

Send either a text string or a file object. A file is decoded as UTF-8 and must be one of text/plain, text/markdown, text/html, text/csv.

Response

The result carries your remaining balance alongside it, so you can track spend without a second call.

{
  "slug": "creme-brulee-a-recipe",
  "length": 21,
  "request_id": "37f01edb-0163-42a1-ac51-0acaef979800",
  "credits_remaining": 96
}

Cost

1 credit per call, whether it is run from the site or from the API — the credential differs, the price does not. A new account starts with 20 credits.

A rejected request still costs a credit: the authorizer decrements before the tool validates. A call rejected for a missing or invalid key is free.

Parameters

Generated from the endpoint’s own validation, so this is exactly what it accepts. A body field goes at the top level; an option goes inside options.

NameInTypeDefaultNotes
max_lengthoptionsinteger100Cut back to the last whole word within this length. 1 to 500
separatoroptionsstring"-"Single character joining words. Defaults to a hyphen.