Zum Inhalt springen
Dokumentationsmenü

Grundlagen der REST-API

Die gleichen Operationen wie die MCP-Tools, als JSON über HTTP. Die wichtigen Strukturen und wo die vollständige Referenz zu finden ist.

Die REST-API ist für CI-Skripte und Clients ohne MCP. Dieselben Operationen, dieselbe Validierung, dasselbe Fehlerformat wie bei den Tools.

Grundlagen

  • Basis-URL: https://app.tileset.com.
  • Authentifizierung: Authorization: Bearer <API key> bei jedem Aufruf. Siehe API-Schlüssel.
  • Bodies sind JSON. Ein ungültiger Wert gibt einen Fehler mit field, received und allowed zurück, sodass ein Skript sich selbst korrigieren kann. Beim Erstellen und beim Ändern eines Widgets wird ein ungültiger Wert auf die gleiche Weise abgelehnt.

Die wichtigsten Aufrufe

AufrufFunktion
POST /v1/sourcesEine Quelle verbinden: type, "mode": "live", plus eine der folgenden: query (Google), channelHandle (YouTube), pinterestUrl (ein Pinterest-Profil- oder Board-Link), xHandle (ein X-@Handle oder Profil-Link), twitchChannel (ein Twitch-Kanalname oder Twitch.tv-Link), kickChannel (ein Kick-Kanalname oder Kick.com-Link). label ist optional: Lassen Sie es weg und die Quelle wird nach ihrem Konto oder Unternehmen benannt (eine Testimonial-Quelle nimmt nur type und label). Ohne "mode": "live" erhalten Sie eine Demo-Quelle mit Beispielinhalten; mit ihr beantwortet eine Anfrage, der der Typ-Feld fehlt, 400 und benennt das Feld.
GET /v1/sources, GET/PATCH/DELETE /v1/sources/:idQuellen auflisten, lesen, ändern oder entfernen. PATCH nimmt label (umbenennen), updateEvery, manualOnly und schedule. Ein PATCH mit mehreren Teilen speichert alle oder keinen
POST /v1/sources/:id/testimonials, GET /v1/sources/:id/testimonialsFügen Sie bis zu 20 Testimonials hinzu (sie warten im Dashboard auf Freigabe) oder zählen Sie die wartenden, freigegebenen und gefilterten (nur Testimonials, die über den Link gesendet werden, werden geprüft, niemals das, was ein Schlüssel hinzufügt). Ein Schlüssel liest die Einträge nie zurück. Freigeben, Ablehnen (einzeln oder mehrere gleichzeitig), Bearbeiten, Löschen, die Reihenfolge und das Pausieren oder Fortsetzen des Links beantworten einen API-Schlüssel mit 403: Eine Person erledigt diese im Dashboard.
GET /v1/sources/:id/contentZählungen für die Auswahl eines Designs: wie viele Elemente, deren Daten und Tempo, Sternebewertungen, Fotos und Videos, Bildformen, Textlängen, Schriftsysteme und Antworten des Eigentümers. Niemals die Elemente.
GET/POST /v1/bio, GET/PATCH/DELETE /v1/bio/:idSeiten auflisten oder erstellen „Link in bio“ (name, die Felder der Seite und slug ab Starter und höher; ohne eine davon wird der Seite eine Adresse zugewiesen) und eine lesen, ändern (blocks ersetzt die Liste, style ändert nur die von Ihnen gesendeten Schlüssel) oder löschen. POST /v1/bio/:id/blocks hängt Blöcke an, GET /v1/bio/slug?slug=<slug> prüft, ob eine Adresse frei ist, und GET /v1/bio/:id/analytics?days=7|30|90 gibt Aufrufe und Link-Klicks zurück (die letzten 7 Tage erfordern einen höheren Plan). Eine belegte Adresse ergibt 409; eine Seite, die die Plananzahl überschreitet, oder ein gesperrtes Feld ergibt 403
POST /v1/widgetsEin Widget aus einer Quelle erstellen (sourceId, type, plus Optionen)oder aus bis zu vier mit sourceIds für einen gemischten Feed
GET /v1/widgets, GET/PATCH/DELETE /v1/widgets/:idWidgets auflisten, lesen, ändern oder löschen
POST /v1/widgets/:id/check-pageEine Seite auf dieses Widget prüfen (url): dieselbe Prüfung wie das Tool verify_install. Gibt verified zurück, was es in lines gefunden hat, und hints mit einer Lösung für jeden häufigen Fehler. Eine lokale oder private Adresse wird mit 400 abgelehnt; 30 Prüfungen pro Stunde
GET /v1/credits, PATCH /v1/creditsGuthaben und Prognose; monatliche Obergrenze festlegen
GET /v1/pricesÖffentlich, kein Schlüssel: Was eine Aktualisierung pro Quellentyp kostet
GET /v1/widgets/:id/contentÖffentlich, mit CORS: das eigene Lesen des Embeds, nur zur Anzeige über das Widget (keine Daten-API)
POST /v1/hooks/:secretEin Webhook einer Quelle (kein Schlüssel; das Geheimnis ist die Anmeldeinformation)

Ein Konto kann höchstens 200 Widgets enthalten.

Zahlen, nie Inhalte

Ein Schlüssel liest niemals Ihre Inhalte: kein Aufruf beantwortet ihn mit einem Beitrag oder einer Bewertung. Um das Ergebnis zu sehen, öffnen Sie https://app.tileset.com/preview/<widgetId>, das Widget, wie Besucher es sehen. Der Fehler einer fehlgeschlagenen Quelle wird als fester Satz angezeigt.

Faire Nutzung

Die Fair-Use-Limits antworten mit 429 und reason, why, limit und retryAt, plus einem Retry-After-Header: warten Sie bis dahin, versuchen Sie es nicht früher. Eine Suche nach einem Unternehmensnamen, die das Tageslimit überschreitet, erhält ebenfalls 429. Eine neue Google-Quelle, die die geteilte Tageszahl überschreitet, wird mit queued verbunden und erscheint in Listen mit firstFetchQueued true, bis ihre Bewertungen nach 00:00 UTC eintreffen.

Vollständige Referenz

Die vollständige, aktuelle Referenz ist llms.txt. Sie wird aus derselben Quelle wie die MCP-Tools erstellt, sodass die beiden immer übereinstimmen. Ihre Seite ruft niemals die API auf: sie lädt nur das Widget-Skript.