# Slugify — Bulk URL Slug & Permalink Generator (`hipersoft/slugify-permalink`) Actor

Turn titles and text into clean URL slugs in bulk, with transliteration, custom separators, lowercasing and length limits. Export a ready-to-use slug for every row.

- **URL**: https://apify.com/hipersoft/slugify-permalink.md
- **Developed by:** [hiper soft](https://apify.com/hipersoft) (community)
- **Categories:** Developer tools, Other
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $0.001 / slug generated

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.
Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).

# README

## Slugify — Bulk URL Slug & Permalink Generator

**Turn titles and text into clean URL slugs in bulk.** Paste a list of titles and get a safe, readable permalink for every one — with transliteration (café → cafe, Größe → grosse), custom separators, lowercasing, length limits and automatic uniqueness. Ideal for CMS migrations and publishing at scale.

### What it does

- Converts any string into a **URL-safe slug** (`Hello World!` → `hello-world`).
- **Transliterates** accents and non-Latin characters to ASCII.
- Custom **separator**, optional **lowercase**, and a **max length** cap.
- **Ensures uniqueness** across the batch by adding a numeric suffix to repeats.

### Use cases

- **CMS migration** — generate permalinks for thousands of posts/products from a spreadsheet.
- **Publishing** — slugify article titles before import.
- **E-commerce** — build clean category/product URLs at scale.

### Input

```json
{ "texts": ["Hello World! My First Post", "Café León — 2026 Edition"], "separator": "-", "lowercase": true, "maxLength": 0, "ensureUnique": true }
```

| Field | Type | Description |
|---|---|---|
| `texts` | array | Strings/titles to slugify — one slug per entry. |
| `separator` | string | Character between words. Default `-`. |
| `lowercase` | boolean | Lowercase the slug. Default `true`. |
| `maxLength` | integer | Trim to at most N characters (0 = no limit). |
| `ensureUnique` | boolean | Add a suffix when a slug repeats. Default `true`. |

### Output

```json
{ "original": "Hello World! My First Post", "slug": "hello-world-my-first-post" }
```

#### Output schema

| Field | Type | Description |
|---|---|---|
| `original` | string | The input string. |
| `slug` | string | The generated URL slug. |

### FAQ

**Does it handle accents and other languages?** Yes — accents and many non-Latin scripts are transliterated to ASCII.

**What export formats are supported?** JSON, CSV, Excel and XML, plus the Apify API.

**Can I automate it?** Yes — connect it via [integrations on the Apify platform](https://apify.com/integrations) including [Make](https://apify.com/integrations/make), [Zapier](https://apify.com/integrations/zapier) and the [Apify API](https://docs.apify.com/api/v2).

### Notes

Original clean-room implementation.

# Actor input Schema

## `texts` (type: `array`):

The strings or titles to turn into URL slugs — one slug is generated per entry.

## `separator` (type: `string`):

Character used between words in the slug.

## `lowercase` (type: `boolean`):

Convert the slug to lowercase.

## `maxLength` (type: `integer`):

Trim the slug to at most this many characters (0 = no limit).

## `ensureUnique` (type: `boolean`):

Append a numeric suffix when the same slug occurs more than once in the batch.

## Actor input object example

```json
{
  "texts": [
    "10 Best Tips for SEO",
    "Größe & Preis"
  ],
  "separator": "-",
  "lowercase": true,
  "maxLength": 0,
  "ensureUnique": true
}
```

# Actor output Schema

## `results` (type: `string`):

The results as dataset items.

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "texts": [
        "Hello World! My First Post",
        "Café León — 2026 Edition"
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("hipersoft/slugify-permalink").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = { "texts": [
        "Hello World! My First Post",
        "Café León — 2026 Edition",
    ] }

# Run the Actor and wait for it to finish
run = client.actor("hipersoft/slugify-permalink").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "texts": [
    "Hello World! My First Post",
    "Café León — 2026 Edition"
  ]
}' |
apify call hipersoft/slugify-permalink --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,hipersoft/slugify-permalink"
        }
    }
}

```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/w7KgRnbhCk8MXV22i/builds/nxZumXtvCWewrBYlQ/openapi.json