Operator API

TeleURL API Guide

This guide is for authorized operators integrating trusted server-side services with TeleURL. Keep API keys on private infrastructure only. Never place API keys in browser JavaScript, mobile apps, public repositories, logs, or client-visible configuration.

The canonical API base for TeleURL 1.0 is https://teleurl.com/api. Product integrations should use this base URL for all server-side automation.

Authentication

Generate an API key from Settings after signing in. Send it as the x-api-key header on API requests.

Health

curl "https://teleurl.com/api/health"

List your short links

curl "https://teleurl.com/api/links?limit=10&skip=0" \
  -H "x-api-key: $TELEURL_API_KEY"

Optional query parameters include limit, skip, and all=true for admin-only all-link views.

Create a short link

curl -X POST "https://teleurl.com/api/links" \
  -H "Content-Type: application/json" \
  -H "x-api-key: $TELEURL_API_KEY" \
  --data '{"target":"https://auto-bot.io","customurl":"autobot","description":"Main site"}'

Common fields are target, customurl, description, reuse, password, and expire_in. Custom slugs require an authenticated API key.

Update a short link

curl -X PATCH "https://teleurl.com/api/links/LINK_ID" \
  -H "Content-Type: application/json" \
  -H "x-api-key: $TELEURL_API_KEY" \
  --data '{"description":"Updated label"}'

Delete a short link

curl -X DELETE "https://teleurl.com/api/links/LINK_ID" \
  -H "x-api-key: $TELEURL_API_KEY"

Read link stats

curl "https://teleurl.com/api/links/LINK_ID/stats" \
  -H "x-api-key: $TELEURL_API_KEY"

Domains

curl -X POST "https://teleurl.com/api/domains" \
  -H "Content-Type: application/json" \
  -H "x-api-key: $TELEURL_API_KEY" \
  --data '{"address":"links.example.com","homepage":"https://auto-bot.io"}'
curl -X DELETE "https://teleurl.com/api/domains/DOMAIN_ID" \
  -H "x-api-key: $TELEURL_API_KEY"

Current user

curl "https://teleurl.com/api/users" \
  -H "x-api-key: $TELEURL_API_KEY"

Admin endpoints

Admin API keys can read admin tables through /api/links/admin, /api/users/admin, and /api/domains/admin. Admin mutation endpoints can affect users, domains, and links; use them only from trusted operator tooling.

Operational notes