API & SDKs. Build on Elido, in any language.
Vollständige REST API, TypeScript, Go und Python SDKs sowie ein MCP-Server für KI-Agenten-Workflows. Ratenbegrenzungen skalieren mit dem Plan; API-Keys sind Workspace-bezogen mit granularen Berechtigungssätzen.
- TypeScript, Go, and Python SDKs — all open-source
- OpenAPI 3.1 spec with interactive docs
- MCP server for Claude and AI agent workflows
- Per-scope API keys with plan-based rate limits
Official SDKs
Four SDKs. One API surface.
Every SDK is generated from the same OpenAPI 3.1 spec — when the API ships, the SDKs update the same day. TypeScript types, Go interfaces, and Python dataclasses stay in sync automatically.
Typed request/response objects. Works in Node.js, Cloudflare Workers, Vercel Edge, and Deno.
npm install @elido/sdkIdiomatic Go with context propagation and zero-allocation hot paths for high-throughput services.
go get github.com/elidoapp/elido-goSync and async (asyncio) clients. Typed with Pydantic v2 models. Available on PyPI.
pip install elido-sdkModel Context Protocol server — connect Elido link management to Claude, ChatGPT, Cursor, and any MCP-compatible AI agent.
npx @elido/mcp-serverAPI reference
OpenAPI 3.1. Interactive. Always current.
The OpenAPI spec at /openapi.json is the source of truth for every endpoint, parameter, and response shape. SDK types are generated from it — no drift, no hand-maintained stubs.
- Downloadable spec/openapi.json — machine-readable JSON
- Interactive referenceAuthenticated calls from the browser
- Postman collectionAuto-generated from the OpenAPI spec
- SDK generationTypes built from spec on every release
- 90-day deprecationBreaking changes flagged well in advance
- POST
/v1/linksCreate a short link - GET
/v1/links/{id}Retrieve a link by ID - PATCH
/v1/links/{id}Update link destination or metadata - DELETE
/v1/links/{id}Archive or delete a link - GET
/v1/linksList links (cursor-paginated) - POST
/v1/bulk/linksBulk-create up to 500 links
X-RateLimit-Remaining
X-RateLimit-Reset
Rate limits
Limits that scale with your plan.
Token-bucket rate limiting per workspace per API key. Burst allowances let you spike 10x for up to 5 seconds — so a batch link-creation job at the start of a campaign never hits the wall.
- X-RateLimit-Limit / Remaining / Reset headers on every response
- SDK auto-retries with exponential backoff on 429
- Bulk endpoints have separate, higher limits
- Per-scope keys — analytics read-only keys don't burn write quota
- Custom limits for high-volume enterprise workloads — contact sales
What you can do
- REST API mit OpenAPI 3.1 Spezifikation
- TypeScript, Go und Python SDKs
- MCP-Server für Claude, ChatGPT, Cursor
- Workspace-bezogene API-Keys mit Berechtigungen pro Scope
- Webhooks für asynchrone Ereignisübermittlung
- Interne gRPC API (Edge → Core)
Was der Elido API-Stack Entwicklern bietet
Eine OpenAPI-Spezifikation und einige SDKs sind nur die Basis. Die untenstehenden Funktionen decken die Details ab, auf die es bei der Erstellung von Produktionsintegrationen ankommt.
OpenAPI 3.1 Spezifikation, Postman-Kollektion und interaktive Referenz — jeder Endpunkt mit Beispielen dokumentiert
Jeder Elido API-Endpunkt ist in der OpenAPI 3.1 Spezifikation dokumentiert, die unter /docs/api-reference und als herunterladbare JSON-Datei unter /openapi.json verfügbar ist. Die Spezifikation ist die Source of Truth — SDK-Typen werden daraus generiert, sodass es keine Abweichungen zwischen der Referenz und dem SDK gibt. Die interaktive API-Referenz ermöglicht es Ihnen, authentifizierte Aufrufe gegen Ihren Workspace direkt im Browser durchzuführen (API-Key einfügen, Workspace wählen, Endpunkt aufrufen). Eine Postman-Kollektion wird automatisch aus der OpenAPI-Spezifikation generiert und von jeder Endpunkt-Dokumentationsseite verlinkt. Das Changelog für die API wird zusammen mit dem Haupt-Changelog versioniert — bei Breaking Changes gibt es eine 90-tägige Ankündigungsfrist mit einem Migrationsleitfaden vor der Entfernung.
TypeScript, Go und Python SDKs — generiert aus der OpenAPI-Spezifikation, aktualisiert bei jedem API-Release
Das TypeScript SDK (@elido/sdk) wird auf npm veröffentlicht und deckt die gesamte API-Oberfläche mit typisierten Anfrage- und Antwortobjekten ab. Es unterstützt sowohl Node.js als auch Edge-Runtimes (Cloudflare Workers, Vercel Edge, Deno). Das Go SDK (github.com/elidoapp/elido-go) ist idiomatisches Go mit Context Propagation und Zero-Allocation Hot Paths für hohen Durchsatz. Das Python SDK (elido-python, verfügbar auf PyPI) enthält sowohl synchrone als auch asynchrone (asyncio) Clients. Alle drei SDKs werden aus derselben OpenAPI-Spezifikation mit einem benutzerdefinierten Generator generiert — Updates werden am selben Tag wie das API-Release ausgeliefert. Von der Community gepflegte SDKs für Ruby und PHP existieren; sie sind in der Dokumentation aufgeführt, werden aber nicht offiziell unterstützt. Wenn Ihre Sprache nicht abgedeckt ist, ist die OpenAPI-Spezifikation der schnellste Weg, einen Client zu bauen.
Workspace API-Keys mit Berechtigungen pro Scope — separate Keys für Read-only Analytics vs. Link-Management vs. Admin
API-Keys sind Workspace-bezogen (nicht Benutzer-bezogen) und enthalten einen Berechtigungssatz, der bei der Erstellung des Keys definiert wird. Scopes: links:read, links:write, links:delete, analytics:read, campaigns:read, campaigns:write, webhooks:manage, domains:manage, workspace:admin. Read-only Analytics-Integrationen sollten einen Key mit nur analytics:read verwenden. CI/CD-Pipelines, die Links erstellen, sollten links:write verwenden. Admin-Operationen erfordern workspace:admin. Keys können einzeln rotiert werden, ohne andere Keys zu widerrufen — die Rotation generiert einen neuen Key-Wert, der alte Wert wird sofort ungültig. Keys werden nur einmal bei der Erstellung angezeigt; Elido speichert einen HMAC des Keys, nicht den Klartext. Für SCIM-provisionierte Teams werden Service-Account-Keys anstelle von persönlichen API-Keys für Produktionsintegrationen empfohlen.
Elido MCP-Server: Verbinden Sie das Link-Management mit Claude, ChatGPT, Cursor und jedem MCP-kompatiblen KI-Agenten
Der Elido MCP-Server (@elido/mcp-server, veröffentlicht auf npm) implementiert das Model Context Protocol und stellt das Elido Link-Management als Tools zur Verfügung, die von KI-Agenten aufgerufen werden können. Unterstützte Tools: create_link, get_link, update_link, list_links, get_analytics, create_campaign, list_campaigns. Der MCP-Server authentifiziert sich mit einem Workspace API-Key und beschränkt den Tool-Zugriff auf die Berechtigungen des Keys. Integrieren Sie ihn in Claudes Tool-Use-Loop, die ChatGPT Plugins (Function Calling), Cursors KI-Kontext oder jede MCP-kompatible Runtime. Beispiel für einen Use Case: Ein KI-Assistent, der ein Briefing in natürlicher Sprache entgegennimmt ('Erstelle fünf Links für diesen Produktlaunch, einen pro Kanal, mit UTMs aus der Kampagnenvorlage Q2-Launch') und create_link fünfmal mit den richtigen, aus dem Briefing abgeleiteten Parametern aufruft. Der MCP-Server ist selbst-hostbar oder wird als npx-Binärdatei für die lokale Entwicklung ausgeführt.
Ratenbegrenzungen nach Plan — Free 60/Min, Pro 300/Min, Business 1.000/Min — plus Burst-Zulagen
API-Ratenbegrenzungen gelten pro Workspace und API-Key: Free 60 Anfragen/Minute, Pro 300/Minute, Business 1.000/Minute. Burst-Zulagen ermöglichen es Ihnen, das Limit für bis zu 5 Sekunden (10-fache der Ratenbegrenzung) zu überschreiten, bevor das harte Limit greift. Rate-Limit-Header sind in jeder Antwort enthalten: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset (Unix-Timestamp). Die SDKs enthalten automatische Wiederholungsversuche mit exponentiellem Backoff bei 429-Antworten — Sie müssen dies nicht selbst implementieren. Für Bulk-Operationen (Link-Erstellung, Analytics-Export) bevorzugen Sie die Bulk-Endpunkte (POST /bulk, geplante Exporte) gegenüber API-Aufrufen pro Element — Bulk-Endpunkte haben separate, höhere Limits. Wenn Ihr Use Case einen dauerhaften Durchsatz über den Business-Limits erfordert (z. B. ein selbst gehosteter Redirector mit hohem Volumen, der die Elido-API zur Cache-Befüllung aufruft), kontaktieren Sie den Vertrieb für ein individuelles Limit.
Entwicklerteams, die auf der Elido API aufbauen
Namen sind Platzhalter — echte Kunden-Fallstudien werden hier veröffentlicht, sobald sie verfügbar sind.
“Die Typen des TypeScript SDK werden aus der OpenAPI-Spezifikation generiert — wenn Elido eine neue API-Version ausliefert, aktualisieren wir die Paketversion und TypeScript sagt uns sofort, ob unsere Integration ein veraltetes Feld verwendet. Keine überraschenden Laufzeitfehler.”
“Wir haben den Elido MCP-Server in Claude integriert, damit unser Content-Team Kampagnen-Links über eine Chat-Oberfläche erstellen und taggen kann. Die Einrichtung dauerte 20 Minuten. Das Content-Team erstellt nun 40 % weniger Support-Tickets für das Engineering für Link-Management-Aufgaben.”
“Das Go SDK mit Context Propagation passt direkt in unser Service Mesh. Wir erstellen serverseitig Kurzlinks für Sendungsverfolgungsseiten zum Zeitpunkt der Sendungserstellung — das SDK kümmert sich transparent um Wiederholungen und Rate-Limit-Backoff.”
Elido API & SDKs vs. Bitly API vs. Rebrandly API
Alle drei verfügen über REST APIs. Die Unterschiede liegen in der SDK-Qualität, den Ratenbegrenzungen, der Verfügbarkeit der OpenAPI-Spezifikation und der MCP/KI-Agenten-Unterstützung.
| Feature | Elido | Bitly API | Rebrandly API |
|---|---|---|---|
| OpenAPI / Swagger Spezifikation | OpenAPI 3.1 — herunterladbar, Source of Truth für SDKs | Swagger Spezifikation verfügbar | OpenAPI Spezifikation verfügbar |
| Offizielle SDKs | TypeScript, Go, Python — generiert aus Spezifikation | Offizielle JavaScript und Python SDKs | Nur JavaScript SDK |
| Ratenbegrenzung (Business) | 1.000 Anfragen/Min. mit Burst | Enterprise-Plan: variiert je nach Vertrag | 500 Anfragen/Min. (Business) |
| MCP-Server für KI-Agenten | Ja — @elido/mcp-server auf npm | Nicht verfügbar | Nicht verfügbar |
| API-Key-Berechtigungen pro Scope | Ja — 9 Scopes, Zuweisung pro Key | Nur Read-only vs. Read-write | Eingeschränkte Scope-Kontrolle |
| Webhook-Übermittlung | HMAC-SHA256 signiert, Auto-Retry, SIEM-Modus | Nicht verfügbar | Nicht verfügbar |
| Interne gRPC API | Ja — Edge zu Core, interne Aufrufe mit niedriger Latenz | Nur REST | Nur REST |
Fragen zu API & SDK
Ist die API versioniert? Wie funktionieren Breaking Changes?
Ja. Die aktuelle Version ist v1, erreichbar unter /v1/... Breaking Changes werden im Changelog mit einem 90-tägigen Deprecation-Fenster angekündigt, bevor das alte Verhalten entfernt wird. Nicht-bahnbrechende Ergänzungen (neue Felder, neue optionale Parameter) werden ohne Versionssprung ausgeliefert. Die API-Version ist stabil; falls jemals v2 eingeführt wird, wird v1 für mindestens 12 Monate parallel laufen. Die OpenAPI-Spezifikation unter /openapi.json spiegelt immer die aktuelle stabile Version wider.
Welche Authentifizierungsmethode verwendet die API?
Bearer-Token-Authentifizierung: Fügen Sie Ihren API-Key in den Authorization-Header als 'Bearer elido_sk_...' ein. Der Key-Wert wird nur einmal bei der Erstellung angezeigt. Für Server-zu-Server-Webhook-Aufrufe von Elido an Ihr System signiert Elido den Request-Body mit HMAC-SHA256 unter Verwendung eines Shared Secrets — verifizieren Sie den X-Elido-Signature-Header in Ihrem Webhook-Handler. OAuth2-Client-Credentials sind für Partner-Integrationen verfügbar, bei denen die Verteilung von Workspace API-Keys unpraktisch ist — kontaktieren Sie uns für das OAuth2-Partner-Onboarding.
Funktioniert das TypeScript SDK in Cloudflare Workers und Edge-Runtimes?
Ja. Das TypeScript SDK verwendet die fetch API (verfügbar in allen modernen Edge-Runtimes) und vermeidet Node.js-exklusive APIs (kein fs, kein http, kein Buffer). Es wird auf Cloudflare Workers, Vercel Edge Functions und Deno Deploy getestet. Wenn Sie das SDK in einer eingeschränkten Edge-Umgebung ausführen, verwenden Sie den Lightweight-Importpfad (@elido/sdk/edge), der die CLI-Utilities und Node.js-exklusive Module aus dem Bundle ausschließt.
Wie verwende ich den MCP-Server mit Claude oder ChatGPT?
Für Claude: Fügen Sie den MCP-Server zu Ihrer claude_desktop_config.json mit Ihrem API-Key als Umgebungsvariable hinzu — die Elido MCP-Dokumentation enthält eine One-Block-Copy-Paste-Konfiguration. Für ChatGPT (Function Calling): Der MCP-Server stellt ein JSON-Schema-Tool-Manifest unter /.well-known/mcp.json bereit, das Sie in die Action-Konfiguration Ihres GPTs importieren können. Für Cursor: Fügen Sie den MCP-Server als lokales Tool in den Cursor-Einstellungen mit npx @elido/mcp-server hinzu. Alle Konfigurationen erfordern einen gültigen Elido API-Key mit den entsprechenden Scopes.
Wie sieht das Paginierungsmodell für List-Endpunkte aus?
Alle List-Endpunkte verwenden Cursor-basierte Paginierung. Die Antwort enthält ein next_cursor-Feld (null, wenn keine weiteren Seiten vorhanden sind). Übergeben Sie den Cursor-Wert als cursor-Query-Parameter bei der nächsten Anfrage. Die Standard-Seitengröße beträgt 50, das Maximum 200. Die Cursor-basierte Paginierung ist stabil — das Hinzufügen oder Löschen von Datensätzen zwischen den Seiten führt nicht dazu, dass Elemente übersprungen oder wiederholt werden, anders als bei der Offset-basierten Paginierung. Die SDKs enthalten einen Auto-Paginate-Helper, der Elemente nacheinander ausgibt, unabhängig von Seitengrenzen.
Kann ich die API verwenden, um mehrere Workspaces von einem einzigen Client aus zu verwalten?
Ja. API-Keys sind Workspace-bezogen, aber Sie können Keys für mehrere Workspaces besitzen. Das API-Endpunkt-Präfix lautet /v1/workspaces/{workspace_id}/... — übergeben Sie die Workspace-ID des Ziel-Workspaces. Wenn Sie ein Management-Tool für mehrere Workspaces erstellen (z. B. ein Agenturportal zur Verwaltung von Kunden-Workspaces), besitzen Sie einen API-Key pro Workspace. OAuth2-Partner-Credentials mit Workspace-übergreifendem Scope sind für Plattform-Integrationen verfügbar — kontaktieren Sie den Vertrieb.
Wie hoch ist die Ratenbegrenzung im Free-Plan und wie wird sie durchgesetzt?
Free-Plan: 60 Anfragen pro Minute pro Workspace. Die Ratenbegrenzung wird am API-Gateway mit einem Token-Bucket-Algorithmus durchgesetzt. Wenn der Bucket leer ist, gibt die API HTTP 429 mit einem Retry-After-Header zurück, der angibt, wann der nächste Token verfügbar ist. Die SDKs berücksichtigen Retry-After bei 429-Antworten automatisch. Beachten Sie, dass Bulk-Endpunkte separate Limits haben — der Bulk-Create-Endpunkt für Links zählt als eine Anfrage, unabhängig davon, wie viele Links im Payload enthalten sind.
Gibt es eine Sandbox- oder Testumgebung?
Ja — übergeben Sie den Header X-Elido-Sandbox: true bei jeder API-Anfrage, um sie in der Sandbox-Umgebung auszuführen. Sandbox-Anfragen erstellen echte Objekte in einer Sandbox-Workspace-Partition (Links, Kampagnen usw.), aber der Redirect-Traffic wird nicht vom Produktions-Edge bedient. Verwenden Sie die Sandbox für Integrationstests und CI/CD-Pipelines. Sandbox-Objekte werden nicht auf die Link- oder Klick-Quotas Ihres Plans angerechnet. Die Sandbox wird alle 24 Stunden zurückgesetzt — verlassen Sie sich nicht auf Sandbox-Daten für den Produktionseinsatz.
Keep reading
HMAC-signierte Outbound-Ereignisübermittlung — die asynchrone Ergänzung zur synchronen API.
Die API-Ressource, die Sie am häufigsten aufrufen werden — Kurzlinks programmgesteuert erstellen, aktualisieren und abfragen.
Klick-Ereignisse und Aggregate über die Analytics API abfragen — dieselben Daten wie im ClickHouse-Dashboard.
Die entwicklerorientierte Lösungsseite — REST, SDKs, Webhooks und der Überblick über die Developer Experience.
Bereit zum Ausprobieren?
Starten Sie mit dem kostenlosen Plan, upgraden Sie, wenn Sie eine benutzerdefinierte Domain benötigen.