Slug Collision Check

Overview

You send a slug and the slugs you already have, and we tell you whether it clashes and which alternatives are free. The comparison is entirely yours to set: a normalisation form, whether case is folded, and whether trailing separators count — and whatever you pick is applied to your candidate and to every entry alike, then compared code point for code point. Where there is a clash you get numbered alternatives, generated by a published rule and checked against the same set, so the first one you take is free. We do not generate a slug from a title and we do not reserve anything: the set we compare against is the one you sent.

Slug generators stop at the character rules and leave the interesting half to you: whether the result is taken, and what to call it if it is. Doing that by hand means reimplementing a normalisation form, a case fold and a numbering loop, and getting one of them subtly different from the database that stores the answer.

When to use it

Scope

Non-goals

• Does not generate a slug from a title — text.slugify owns that half
• Does not guarantee uniqueness: the set compared against is the one you sent, and the unique index in your store is what actually enforces it
• Does not reserve, lock or remember a suggestion, so two callers asking at the same moment get the same answer
• Does not read any storage, and takes no separator character from you

Properties

Capabilities

Cost & billing

Flat rate per invocation

File handling

How we handle your data

Input schema

Output schema

API contract

curl -sS -X POST "$BASE/v1/execute" -H "Authorization: Bearer $KEY" -H 'Content-Type: application/json' -d '{"skillKey":"marketing.slug_collision_check","input":{"slug":"spring-launch","existing":["spring-launch"]}}'

import { Squillify } from "@squillify/sdk";

const sq = new Squillify({ apiKey: process.env.SQUILLIFY_API_KEY });

const { output } = await sq.execute("marketing.slug_collision_check", {"slug":"spring-launch","suggestionCount":3,"existing":["spring-launch","autumn-launch"]});

Errors

Other limits

Limitations

• Does not generate a slug from a title — text.slugify owns that half
• Does not guarantee uniqueness: the set compared against is the one you sent, and the unique index in your store is what actually enforces it
• Does not reserve, lock or remember a suggestion, so two callers asking at the same moment get the same answer
• Does not read any storage, and takes no separator character from you
• Turning a title into a slug in the first place
• Guaranteeing a slug will still be free when the insert runs
• Checking against a set too large to send, such as a whole catalogue

How to call

POST /v1/execute (requires authentication)

{
  "skillKey": "marketing.slug_collision_check",
  "input": {
    "slug": "spring-launch",
    "suggestionCount": 3,
    "existing": [
      "spring-launch",
      "autumn-launch"
    ]
  }
}

Examples

{
  "slug": "spring-launch",
  "suggestionCount": 3,
  "existing": [
    "spring-launch",
    "autumn-launch"
  ]
}

{
  "available": false,
  "collisionIndex": 0,
  "suggestions": [
    "spring-launch-2",
    "spring-launch-3",
    "spring-launch-4"
  ],
  "normalizedSlug": "spring-launch",
  "summary": {
    "existingCount": 2,
    "distinctExistingCount": 2,
    "duplicateExistingCount": 0,
    "probes": 3,
    "suggestionsExhausted": false,
    "separator": "hyphen",
    "suffixScheme": "numeric_increment",
    "maxSlugLength": 128,
    "comparison": {
      "trimTrailingSeparators": true,
      "caseFold": true,
      "unicodeForm": "nfc"
    }
  }
}

{
  "existing": [
    "spring-launch"
  ],
  "suggestionCount": 0,
  "comparison": {
    "caseFold": false
  },
  "slug": "Spring-Launch"
}

{
  "summary": {
    "existingCount": 1,
    "distinctExistingCount": 1,
    "duplicateExistingCount": 0,
    "probes": 0,
    "suggestionsExhausted": false,
    "separator": "hyphen",
    "suffixScheme": "numeric_increment",
    "maxSlugLength": 128,
    "comparison": {
      "trimTrailingSeparators": true,
      "caseFold": false,
      "unicodeForm": "nfc"
    }
  },
  "suggestions": [],
  "available": true,
  "normalizedSlug": "Spring-Launch"
}

Recommended use cases

• Check an article or product slug against the ones a section already holds, before showing the author a save button
• Offer numbered alternatives when an editor picks a title that has been used
• Compare slugs the way a store compares them, by matching the normalisation form and case folding to the column collation

Avoid for

• Turning a title into a slug in the first place
• Guaranteeing a slug will still be free when the insert runs
• Checking against a set too large to send, such as a whole catalogue

Related skills

Composable with

Safety & privacy

• Runs without calling any external service.
• Your payloads are never stored permanently.
• Telemetry captures metadata only — never your payload contents.
• We never train models on your payloads.
• No human reviews your payloads.

Tags