Build with the API using an AI assistant

Download the BLNQ skill (SKILL.md or a .zip), hand it to Claude, Cursor, or any LLM, and your assistant writes correct API calls without you pasting docs.

BLNQ ships an AI agent skill: one file that teaches a coding assistant the whole API so it can write correct requests for you, no more pasting endpoint docs into the chat. This guide shows where to get it and how to load it into your tool. New to the API itself? Do the API quickstart first; the skill assumes you already have a blnq_live_ key.

Step 1: Download the skill

On the API reference page (/api), under AI agent skill in the sidebar, there are two downloads:

  • SKILL.md: the raw Markdown file. For coding assistants and project knowledge.
  • Skill .zip (for Claude): the same file wrapped in the folder layout Claude's Skills uploader expects (blnq-link-shortener/SKILL.md).

Step 2a: Load it into Claude

  • Download the .zip from /api.
  • In Claude, open Settings → Capabilities → Skills and upload the zip.
  • Ask in plain language: "create a short link for https://example.com with the slug spring-drop", or "chart last-30-days clicks for my top links". Claude loads the skill and writes the request.

Step 2b: Load it into Cursor, Copilot, or a chat

  • Download SKILL.md.
  • Add it as project context: a Cursor or Windsurf rules file, your assistant's project knowledge, or a pinned message in a chat.
  • Prompt as usual. The assistant now has the endpoints, error codes, and limits on hand.

Step 3: Give it your key, safely

The skill tells the assistant to read your key from an environment variable (BLNQ_API_KEY) and never hard-code it. Keep your blnq_live_ key in your shell or a secret store; don't paste it into the chat. Reading is free on every plan; creating and editing links needs any paid plan.

What the skill knows

  • Base URL api.blnq.it/v1 and bearer-token auth.
  • Every endpoint: create (one or 50), list with paging/sort/search, fetch, update, delete, stats, QR, /me, and the read-only resource lists.
  • The full error table, the per-plan rate limits, and 429 back-off.
  • The gotchas: slug format, analytics-window caps, and that the short URL always comes back on blnq.it/r/.

The file is generated from the live API, so it can't drift. If your tooling prefers a machine-readable schema, pair it with the OpenAPI spec from the same sidebar.