LinkPilot|Documentation
DashboardGet Started

API Key Guide

What is an API Key?

An API Key is a secure token that allows you to access LinkPilot features from outside the dashboard, such as:

  • Automatically create short links from your application
  • Integrate with automation tools (n8n, Zapier, Make...)
  • Build your own application using LinkPilot as a backend

Creating an API Key

Step 1: Access Settings

From the Dashboard, click on Settings in the left menu.

Step 2: Select API Keys tab

Click on the API Keys tab in the Settings page.

Step 3: Create a new key

  1. Enter a name for your API Key (e.g., "Production", "N8N Integration", "Test")
  2. Click the + Create Key button
  3. IMPORTANT: Copy and save the key immediately!

⚠️ Warning

The full API Key is only displayed ONCE when created. After that, you will not be able to view the full key again. If you lose it, you must create a new key.

Managing API Keys

View key list

All your API Keys are displayed in a table with the following information:

  • Name: The name you assigned to the key
  • Key: Partially hidden key (e.g., lp_abc1...xyz9)
  • Created: When the key was created
  • Last used: When the key was last used

Delete an API Key

  1. Find the key you want to delete in the list
  2. Click the 🗑️ (trash) icon next to the key
  3. Confirm deletion

⚠️ Note

After deletion, all applications using this key will immediately stop working.

Limits

  • Maximum of 10 API Keys per account
  • No rate limiting (currently)

Using Your API Key

Method 1: Authorization Header (Recommended)

curl -X GET "https://linkpilot.theyourlist.com/api/v1/links" \
  -H "Authorization: Bearer lp_your_api_key_here"

Method 2: Query Parameter

curl -X GET "https://linkpilot.theyourlist.com/api/v1/links?api_key=lp_your_api_key_here"

Security Best Practices

✅ Do:

  • Store API Keys in environment variables
  • Create separate keys for each app/environment
  • Delete unused keys
  • Regularly check "Last used" timestamps

❌ Don't:

  • Commit API Keys to Git repositories
  • Share keys via unencrypted email or chat
  • Use the same key for multiple applications
  • Put keys in frontend/client-side code

FAQ

Q: I forgot my API Key, how can I retrieve it?

A: You cannot retrieve a previously created key. Delete the old key and create a new one.

Q: My API Key was exposed, what should I do?

A: Delete the key immediately and create a new one. Update the new key in all applications using it.

Q: Why does the API return 401 Unauthorized?

A: Check: (1) Is the key correct, (2) Has the key been deleted, (3) Is the header/parameter format correct