API

Inhalt

Überblick

v2 ist die API von tellmelo für eigene Programme. Jede Anfrage trägt einen Schlüssel, jede Antwort ist JSON, und jede Liste blättert auf dieselbe Weise. Was hinter einem Schlüssel geschieht, läuft durch dieselben Regeln wie ein Klick in der Anwendung: Tempolimits, Aussetzungen, entzogene Rechte und die Einstellungen dieser Instanz gelten hier genauso.

Jeder Pfad beginnt mit /api/v2 unter der Adresse dieser Instanz, der, die in den Beispielen auf dieser Seite steht.
Anfragen und Antworten sind JSON in UTF-8. Feldnamen, Codes und Werte sind englisch und bleiben es.
Ein Schlüssel handelt als dein Konto und nie darüber hinaus: Was du in der Anwendung nicht sehen kannst, kann auch kein Schlüssel lesen.

https://tellmelo.com/api/v2

Schnellstart

Leg unter „Einstellungen → App & Daten → API“ einen Schlüssel an und kopier ihn. Er wird nur ein einziges Mal gezeigt.
Frag damit die Wurzel ab. Die Antwort sagt, welche Version läuft, was der Schlüssel darf und wie viele Anfragen er in dieser Minute noch hat.
Ab da funktioniert jeder Pfad gleich: der Schlüssel im Header, JSON zurück, und bei Listen items und next.

curl -H "Authorization: Bearer tm_key_…" https://tellmelo.com/api/v2

{
  "name": "tellmelo",
  "version": "2.6",
  "scope": "read write",
  "rateLimit": {
    "limit": 120,
    "remaining": 117
  },
  "docs": "/legal/api",
  "spec": "/api/v2/openapi.json"
}

Wie es weitergeht: /me für dein eigenes Profil, /posts für das Öffentliche, /feed für das, was dir die Anwendung zeigt.

Dein Schlüssel

Es gibt genau einen Schlüssel je Konto, gebunden an deine Benutzerkennung. Er beginnt mit tm_key_, damit ein Scanner ihn dort erkennt, wo er nicht hingehört. Er wird genau einmal angezeigt, im Augenblick seiner Erzeugung; danach liegt hier nur noch sein Fingerabdruck, niemand kann ihn dir zurücklesen, wir nicht und du nicht. Wer ihn verlegt, legt einen neuen an; der alte gilt von da an nicht mehr.

Du legst ihn unter „Einstellungen → App & Daten → API“ an. Er geht im Kopf der Anfrage mit, als Authorization: Bearer tm_key_… oder als X-Tellmelo-Key. Nicht in der Adresszeile, denn was dort steht, landet in Zugriffsprotokollen, im Verlauf des Browsers und im Referer jedes Verweises.

curl -H "Authorization: Bearer tm_key_…" \
  https://tellmelo.com/api/v2/posts

Oder, wenn das bequemer ist, in einem eigenen Kopf:

curl -H "X-Tellmelo-Key: tm_key_…" https://tellmelo.com/api/v2

Nicht in der Adresszeile. Was dort steht, landet im Zugriffsprotokoll jedes Servers dazwischen, im Verlauf des Browsers und im Referer jedes Verweises. Ein Schlüssel gehört dort nicht hin.

Derselbe Schlüssel lädt auch Bilder. Jede url in einer Antwort zeigt auf /api/media dieser Instanz; schick den Schlüssel auch dort im Header mit, dann kommt das Bild zurück, soweit dein Konto es sehen darf.

curl -H "Authorization: Bearer tm_key_…" \
  -o picture.webp "https://tellmelo.com/api/media?id=…"

Was ein Schlüssel darf

Ein Schlüssel trägt zwei Rechte, und jeder Weg in den Tabellen unten sagt, welches davon er braucht. Zwei und nicht fünf: Ein Recht, das man sich nicht in einem Satz erklären kann, ist ein Recht, das man ungelesen anhakt. Und die ehrliche Linie verläuft zwischen Schauen und Ändern.

read: schauen. Die öffentlichen Beiträge, Profile, Communities und Tags, und dein eigenes Konto, so wie du es siehst: Feed, Mitteilungen, Gespräche, Nachrichten.
write: ändern. Alles, was unter deinem Namen geschieht: veröffentlichen, antworten, abstimmen, Nachrichten senden, folgen, beitreten, blockieren, Mitteilungen als gelesen markieren.

Was kein Schlüssel kann

Kein Schlüssel reicht an deine Kontodaten: kein Passwort, keine E-Mail-Adresse, keine Kontoart, kein Ort, keine Rolle, keine Löschung. Auch keine Sitzungen, keine Push-Geräte und die Schlüssel selbst nicht. Einer, der Schlüssel ausstellen könnte, ließe sich nicht mehr abschalten. Auch keine Verwaltung und keine Community-Leitung, denn eine Community aufzulösen oder weiterzugeben ist eine Entscheidung über fremde Beiträge. Was das Passwort hütet, darf kein Schlüssel: Ein Geheimnis, das in einem Skript auf fremder Maschine liegt, darf nicht können, was die Anmeldung kann. Ein Konto zu übernehmen kostet weiterhin die Anmeldung.

Anfragen und Antworten

Überall JSON. Jede Antwort ist application/json in UTF-8, Fehler eingeschlossen. Nur Bilder kommen als Bilder.
Was du schickst. Ein POST trägt seine Felder als JSON-Objekt im Körper. Parameter in der Adresse ergänzen, was der Körper nicht nennt; nennen beide dasselbe Feld, gilt der Körper.
Zeiten sind ganze Millisekunden seit dem 1. Januar 1970, UTC, so, wie die Datenbank sie hält. Es gibt keine Zeitzone, die man falsch lesen kann.
IDs sind Zeichenketten. Nimm sie nicht auseinander und verlass dich nicht auf ihre Form; vergleich sie nur als Ganzes.
Jedes Feld ist immer da. Was es nicht gibt, ist null, nie fehlend; eine Anzahl ist immer eine Zahl, eine Liste immer eine Liste, notfalls leer.
Texte sind reiner Text, genau wie geschrieben. #tags, @namen und Links bleiben, wie sie sind, ebenso die eigenen Emojis der Instanz als :name:; ihre Bilder stehen unter /emojis.
Bilder sind Adressen relativ zu dieser Instanz, /api/media?id=…. Lad sie mit demselben Schlüssel im Header; ohne ihn lautet die Antwort 401.

Seiten

Jede Liste nimmt limit und cursor und antwortet mit items und next. Weiter geht es, indem du das next der letzten Antwort als cursor zurückschickst; ist next leer, ist das Ende erreicht. Eine volle Seite kann trotzdem die letzte sein; wer erst bei einer leeren Seite aufhört, fragt einmal zu oft. Der Cursor ist undurchsichtig: ein Platz in einer Liste, kein Zeitpunkt. Nimm ihn nicht auseinander und baue keinen selbst; was darin steht, darf sich ändern, ohne dass sich ein Weg ändert.

{ "items": [ … ], "next": "MTc1ODYyNDAwMDAwMDo1ZjBjMmE5ZS04ZDQx" }

curl -H "Authorization: Bearer tm_key_…" \
  "https://tellmelo.com/api/v2/posts?limit=20&cursor=MTc1ODYyNDAwMDAwMDo1ZjBjMmE5ZS04ZDQx"

Eine Seite hält ohne limit 20 Einträge, höchstens 50. Ein paar Listen werden gar nicht geblättert. Das steht bei ihrem Pfad, und ihr next ist immer null.

Nur das Neue

Jede Antwort trägt ein ETag. Ein Programm, das immer wieder fragt, sollte das letzte als If-None-Match zurückschicken: Hat sich seitdem nichts geändert, ist die Antwort 304 und trägt keinen Rumpf. Das ist der Unterschied zwischen einer Liste, die jede Minute über die Leitung geht, und einer, die geht, wenn etwas drinsteht, für deine Maschine so wie für diese.

ETag: W/"3Qk1mJ7fQe2Yb0sVxT9aL4pNdRc"
If-None-Match: W/"3Qk1mJ7fQe2Yb0sVxT9aL4pNdRc"  →  304

Zwei Ausnahmen, beide mit Absicht: /feed trägt kein ETag, weil sich seine Reihenfolge mit der Zeit bewegt und jede Antwort anders ist; und ein Schreibzugriff antwortet nie 304. Zwei gleiche Beiträge sind zwei Beiträge.

Grenzen

Ein Schlüssel darf 120 Anfragen je Minute stellen, mit dem Abo „Organisation“ 600, sofern die Verwaltung ihm keine andere Zahl gesetzt hat. Die Grenze gilt je Schlüssel, nicht je Konto und nicht je Adresse. Darüber ist die Antwort 429, und es ist nichts geschehen: Die Anfrage wurde abgelehnt, nicht ausgeführt. Warte eine Minute und schick sie erneut; ein Programm, das regelmäßig anstößt, sollte langsamer werden statt sofort neu zu fragen.

X-RateLimit-Limit: 120
X-RateLimit-Remaining: 117
X-RateLimit-Reset: 1758624060

Neben der Grenze des Schlüssels zählen Schreibzugriffe gegen dieselben Grenzen wie in der Anwendung: wie viele Beiträge, Antworten oder Beziehungen in wenigen Minuten. Auch die antworten 429 mit dem Code rate_limited.

Header

Die Namen sind die, die jede Client-Bibliothek schon kennt. Außer dem Schlüssel ist keiner Pflicht.

Was du schickst

Header	Bedeutung
`Authorization`	Trägt den Schlüssel: `Bearer tm_key_…`. Der übliche Weg.
`X-Tellmelo-Key`	Der Schlüssel, als Alternative zu `Authorization`, für Werkzeuge, die diesen Header für etwas anderes brauchen.
`Content-Type`	`application/json`, für eine Anfrage mit Körper.
`If-None-Match`	Das `ETag` der letzten Antwort. Hat sich seitdem nichts geändert, lautet die Antwort `304` ohne Körper.

Was zurückkommt

Header	Bedeutung
`ETag`	Der Fingerabdruck dieser Antwort, als schwach markiert (`W/`). Schick ihn als `If-None-Match` zurück.
`X-RateLimit-Limit`	Wie viele Anfragen dieser Schlüssel pro Minute stellen darf.
`X-RateLimit-Remaining`	Wie viele davon in der laufenden Minute übrig sind.
`X-RateLimit-Reset`	Wann die nächste Minute beginnt, in Sekunden seit 1970, UTC.
`X-Tellmelo-Scope`	Was dieser Schlüssel darf: `read` oder `read write`.
`Retry-After`	Bei `429`: wie viele Sekunden du warten solltest, bevor du wieder fragst.
`WWW-Authenticate`	Bei `401` wegen eines fehlenden Schlüssels: `Bearer`, so wird ein Schlüssel erwartet.
`Cache-Control`	`no-store`: Kein Proxy dazwischen darf eine Antwort aufheben, weil sie vom fragenden Schlüssel abhängt. Dein eigenes Programm darf sie trotzdem mit dem `ETag` prüfen.

Wenn etwas nicht geht

Fehler kommen als JSON mit zwei Feldern: ein fester englischer Code in error, den dein Programm vergleichen kann, und ein Satz in message für den Menschen davor, dazu der Statuscode, der dazu gehört. Der Code bleibt; der Satz darf sich ändern, und er darf sich in jeder Sprache ändern. Ein Programm, das den Satz vergleicht, geht an einem Tag kaputt, den niemand angekündigt hat.

{ "error": "rate_limited",
  "message": "Too many requests. Try again in a minute.",
  "limit": 120 }

Manche Fehler bringen ein Feld mehr mit: docs bei 401 wegen eines fehlenden Schlüssels, limit bei 429.

Status	Code	Bedeutung
`400`	`bad_request`	Die Anfrage ist nicht lesbar, ein Pflichtfeld fehlt, oder ein Wert gehört nicht zu den erlaubten. `message` sagt, was.
`401`	`key_missing`	Kein Schlüssel im Header.
`401`	`key_invalid`	Der Schlüssel gilt nicht: vertippt, durch einen neuen ersetzt, oder sein Konto ist gesperrt. Was davon, wird bewusst nicht gesagt.
`401`	`unauthorized`	Als nicht angemeldet abgewiesen, aus einem anderen Grund als dem Schlüssel. Selten, und ein Anlass, das Konto hinter dem Schlüssel anzusehen.
`403`	`scope_missing`	Dem Schlüssel fehlt das Recht, das dieser Pfad braucht: meist `write` bei einem Schlüssel, der nur lesen darf.
`403`	`account_data_locked`	Das betrifft deine Kontodaten, an die kein Schlüssel kommt: Passwort, E-Mail-Adresse, Löschung und Ähnliches.
`403`	`forbidden`	Dein Konto darf das nicht: dieselbe Ablehnung wie in der Anwendung, zum Beispiel ein entzogenes Recht oder eine Blockierung.
`404`	`unknown_path`	Diesen Pfad gibt es nicht, oder nicht mit dieser Methode.
`404`	`not_found`	Den Pfad gibt es, aber nicht das, was er nennt, oder du darfst es nicht sehen. Beides wird nicht unterschieden.
`409`	`conflict`	Es kollidiert mit etwas, das schon da ist, zum Beispiel ein vergebener Name.
`413`	`too_large`	Zu groß: ein Text oder eine Anfrage jenseits dessen, was diese Instanz annimmt.
`422`	`unprocessable`	Lesbar, aber in dieser Form nicht möglich.
`429`	`rate_limited`	Zu viele Anfragen. Es ist nichts passiert; warte und schick sie noch einmal.
`500`	`internal_error`	Bei uns ist etwas schiefgegangen, nicht bei dir. Es steht vollständig im Protokoll des Servers.

Versionen

Die Fassung steht im Pfad. Solange dort v2 steht, bleiben diese Wege und ihre Felder, wie sie sind; was dazukommt, kommt daneben.

Ergänzungen erhöhen die zweite Zahl: 2.1 brachte /emojis und das Gelesen-Markieren einer Unterhaltung. 2.4 hat das Feld contentWarning wieder entfernt, weil es keine Inhaltswarnungen mehr gibt. 2.5 hat das Feld alt an Bildern entfernt, weil es keine Bildbeschreibungen mehr gibt. 2.6 bringt die Mitteilungsart team für neue Aufgaben des Teams. Jeder Pfad sagt, seit welcher Version es ihn gibt, und die Wurzel sagt, welche Version läuft.

Endpunkte

Alle Pfade auf einen Blick, danach jeder einzeln: was er nimmt, eine Beispielanfrage und was zurückkommt.

Weg	Recht	Wozu
Der Einstieg
GET`/api/v2`	`read`	Der Eingang: welche Fassung diese API spricht und wie diese Instanz heißt.
Beiträge
GET`/api/v2/posts`	`read`	Die öffentlichen Beiträge, neueste zuerst.
GET`/api/v2/posts/{id}`	`read`	Ein einzelner Beitrag, über seine `id`.
POST`/api/v2/posts`	`write`	Einen Beitrag veröffentlichen.
DELETE`/api/v2/posts/{id}`	`write`	Einen eigenen Beitrag entfernen.
Antworten
GET`/api/v2/posts/{id}/replies`	`read`	Die Antworten auf einen Beitrag, so wie du sie siehst. Was ein geblocktes Konto geschrieben hat, bleibt draußen.
POST`/api/v2/posts/{id}/replies`	`write`	Auf einen Beitrag antworten.
Umfragen
POST`/api/v2/posts/{id}/vote`	`write`	An einer Umfrage teilnehmen.
Profile
GET`/api/v2/profiles/{handle}`	`read`	Ein Profil, über sein Kürzel.
GET`/api/v2/profiles/{handle}/posts`	`read`	Die öffentlichen Beiträge eines Profils, neueste zuerst.
Communities
GET`/api/v2/communities`	`read`	Die offenen Communities dieser Instanz.
GET`/api/v2/communities/{id}`	`read`	Eine einzelne Community, über ihre `id`.
GET`/api/v2/communities/{id}/posts`	`read`	Die öffentlichen Beiträge aus einer Community, neueste zuerst.
Entdecken
GET`/api/v2/tags`	`read`	Die Tags, die gerade laufen.
GET`/api/v2/search`	`read`	Eine Suche über Beiträge, Namen, Kürzel und Tags.
GET`/api/v2/emojis`	`read`	Die eigenen Emojis der Instanz, mit der Adresse ihrer Bilder.
Dein Konto
GET`/api/v2/me`	`read`	Dein eigenes Profil, mit der `id`, die die anderen Wege erwarten.
GET`/api/v2/feed`	`read`	Dein eigener Feed, so wie die Anwendung ihn zusammenstellt.
Mitteilungen
GET`/api/v2/notifications`	`read`	Deine eigenen Mitteilungen, neueste zuerst, blätterbar, damit ein Programm nachholen kann, was es verpasst hat.
POST`/api/v2/notifications/read`	`write`	Deine Mitteilungen als gelesen markieren.
Nachrichten
GET`/api/v2/conversations`	`read`	Dein Postfach: eine Zeile je Gespräch, das jüngste zuerst.
GET`/api/v2/conversations/{with}/messages`	`read`	Die Nachrichten eines Gesprächs, neueste zuerst.
POST`/api/v2/conversations/{with}/messages`	`write`	Eine Nachricht in einem Gespräch senden.
POST`/api/v2/conversations/{with}/read`	`write`	Alle Nachrichten einer Unterhaltung als gelesen markieren.
Beziehungen
POST`/api/v2/relations`	`write`	Mögen, merken, teilen, folgen, beitreten, blockieren, stummschalten, je nach `kind`.

Der Einstieg

Die erste Anfrage jedes Programms: Funktioniert der Schlüssel, und was darf er?

GET`/api/v2`

Der Eingang: welche Fassung diese API spricht und wie diese Instanz heißt.

Recht read
mit ETag
seit v2.0

Ohne Schrägstrich am Ende: /api/v2/ leitet mit 308 auf /api/v2 um, und nicht jedes Programm folgt.

Beispielanfrage

curl \
  -H "Authorization: Bearer tm_key_…" \
  "https://tellmelo.com/api/v2"

Antwort

Antwortet mit einem Service.

Beispiel

{
  "name": "tellmelo",
  "version": "2.6",
  "scope": "read write",
  "rateLimit": {
    "limit": 120,
    "remaining": 117
  },
  "docs": "/legal/api",
  "spec": "/api/v2/openapi.json"
}

Mögliche Status: 200304401429

Beiträge

Öffentliche Beiträge lesen, eigene veröffentlichen und wieder entfernen.

GET`/api/v2/posts`

Die öffentlichen Beiträge, neueste zuerst.

Recht read
blätterbar
mit ETag
seit v2.0

Auf den öffentlichen Pfaden werden Reaktionen nicht gezählt: counts.likes und counts.reposts sind 0 und pinned ist false (ein Ausschnitt, keine Messung).

Beiträge in einer Community erreichst du hier nicht, weder in der Liste noch über ihre id. Sie stehen unter /communities/{id}/posts.

Parameter

Name	Typ	Bedeutung
`limit`in der Adresse	`integer`freiwillig	Wie viele Einträge eine Seite hält: 20 als Vorgabe, höchstens 50.
`cursor`in der Adresse	`string`freiwillig	Wo es weitergeht: das `next` der vorigen Antwort. Ohne ihn von oben.

Beispielanfrage

curl \
  -H "Authorization: Bearer tm_key_…" \
  "https://tellmelo.com/api/v2/posts?limit=20"

Antwort

Antwortet mit einer Seite von Post, als `items` und `next`.

Beispiel

{
  "items": [
    {
      "id": "5f0c2a9e-8d41-4b7a-9c3e-2e61d0f4a7b1",
      "text": "The bees are back in the garden 🐝 #garden",
      "kind": "poll",
      "author": {
        "id": "a3e1f7c2-54b9-4d0e-8f16-7b2c9d4e1a05",
        "handle": "mara",
        "name": "Mara 🌻",
        "verified": true,
        "accountKind": "person"
      },
      "community": {
        "id": "c81d4e2a-0f3b-4a6c-9e57-1d2b3c4a5f60",
        "name": "Urban Gardening"
      },
      "media": [
        {
          "url": "/api/media?id=b2d7e9f1-3c4a-4e8b-a1f0-6d5c4b3a2918"
        }
      ],
      "poll": {
        "options": [
          {
            "text": "Lavender",
            "votes": 12
          },
          {
            "text": "Sunflowers",
            "votes": 7
          },
          {
            "text": "Clover",
            "votes": 3
          }
        ],
        "total": 22,
        "multiple": false,
        "endsAt": 1758710400000,
        "running": true,
        "resultsVisible": true,
        "myVotes": [
          0
        ]
      },
      "quotes": null,
      "continues": null,
      "counts": {
        "replies": 4,
        "likes": 31,
        "reposts": 2
      },
      "pinned": false,
      "createdAt": 1758624000000
    }
  ],
  "next": "MTc1ODYyNDAwMDAwMDo1ZjBjMmE5ZS04ZDQx"
}

Mögliche Status: 200304401429

GET`/api/v2/posts/{id}`

Ein einzelner Beitrag, über seine id.

Recht read
mit ETag
seit v2.0

Auf den öffentlichen Pfaden werden Reaktionen nicht gezählt: counts.likes und counts.reposts sind 0 und pinned ist false (ein Ausschnitt, keine Messung).

Beiträge in einer Community erreichst du hier nicht, weder in der Liste noch über ihre id. Sie stehen unter /communities/{id}/posts.

Parameter

Name	Typ	Bedeutung
`id`im Pfad	`string`Pflicht	Die `id` eines Beitrags.

Beispielanfrage

curl \
  -H "Authorization: Bearer tm_key_…" \
  "https://tellmelo.com/api/v2/posts/5f0c2a9e-8d41-4b7a-9c3e-2e61d0f4a7b1"

Antwort

Antwortet mit einem Post.

Beispiel

{
  "id": "5f0c2a9e-8d41-4b7a-9c3e-2e61d0f4a7b1",
  "text": "The bees are back in the garden 🐝 #garden",
  "kind": "poll",
  "author": {
    "id": "a3e1f7c2-54b9-4d0e-8f16-7b2c9d4e1a05",
    "handle": "mara",
    "name": "Mara 🌻",
    "verified": true,
    "accountKind": "person"
  },
  "community": {
    "id": "c81d4e2a-0f3b-4a6c-9e57-1d2b3c4a5f60",
    "name": "Urban Gardening"
  },
  "media": [
    {
      "url": "/api/media?id=b2d7e9f1-3c4a-4e8b-a1f0-6d5c4b3a2918"
    }
  ],
  "poll": {
    "options": [
      {
        "text": "Lavender",
        "votes": 12
      },
      {
        "text": "Sunflowers",
        "votes": 7
      },
      {
        "text": "Clover",
        "votes": 3
      }
    ],
    "total": 22,
    "multiple": false,
    "endsAt": 1758710400000,
    "running": true,
    "resultsVisible": true,
    "myVotes": [
      0
    ]
  },
  "quotes": null,
  "continues": null,
  "counts": {
    "replies": 4,
    "likes": 31,
    "reposts": 2
  },
  "pinned": false,
  "createdAt": 1758624000000
}

Mögliche Status: 200304400401404429

POST`/api/v2/posts`

Einen Beitrag veröffentlichen.

Recht write
seit v2.0

Ein Beitrag braucht Text oder eine Umfrage. Seine Länge, die Zahl der Antworten einer Umfrage und wie viele Beiträge in welcher Zeit legt diese Instanz fest; darüber lautet die Antwort 400 oder 429, mit einer message, die sagt, was.

Bilder lassen sich über die API noch nicht anhängen, nur in der Anwendung.

Parameter

Name	Typ	Bedeutung
`text`im Körper	`string`freiwillig	Der Text selbst: des Beitrags, der Antwort oder der Nachricht.
`community`im Körper	`string`freiwillig	Die `id` der Community, in die der Beitrag geht. Ohne sie steht er außerhalb jeder Community.
`quotes`im Körper	`string`freiwillig	Die `id` des Beitrags, den dieser zitiert.
`poll`im Körper	`string[]`freiwillig	Die Antwortmöglichkeiten einer Umfrage, als Liste von Texten. Wie viele erlaubt sind, setzt die Instanz.

Beispielanfrage

curl -X POST \
  -H "Authorization: Bearer tm_key_…" \
  -H "Content-Type: application/json" \
  -d '{"text":"The bees are back in the garden 🐝 #garden"}' \
  "https://tellmelo.com/api/v2/posts"

Antwort

Antwortet mit einem Created.

Beispiel

{
  "id": "5f0c2a9e-8d41-4b7a-9c3e-2e61d0f4a7b1",
  "scheduledFor": null,
  "deleteAt": null
}

Mögliche Status: 200400401403429

DELETE`/api/v2/posts/{id}`

Einen eigenen Beitrag entfernen.

Recht write
seit v2.0

Parameter

Name	Typ	Bedeutung
`id`im Pfad	`string`Pflicht	Die `id` eines Beitrags.

Beispielanfrage

curl -X DELETE \
  -H "Authorization: Bearer tm_key_…" \
  "https://tellmelo.com/api/v2/posts/5f0c2a9e-8d41-4b7a-9c3e-2e61d0f4a7b1"

Antwort

Antwortet mit einem Ok.

Beispiel

{
  "ok": true
}

Mögliche Status: 200400401403404429

Antworten

Das Gespräch unter einem Beitrag: gelesen als Liste, die parentId zum Baum macht, geschrieben als Antwort auf den Beitrag oder auf eine Antwort.

GET`/api/v2/posts/{id}/replies`

Die Antworten auf einen Beitrag, so wie du sie siehst. Was ein geblocktes Konto geschrieben hat, bleibt draußen.

Recht read
blätterbar
mit ETag
seit v2.0

Die Liste ist flach und in der Reihenfolge des Schreibens; parentId macht einen Baum daraus. Eine Seite hält ganze Stränge, eine Antwort kommt also nie ohne die, auf die sie antwortet. Was ein Konto schrieb, das du blockiert hast oder das dich blockiert hat, bleibt draußen. Zwei Schlüssel können verschiedene Listen sehen.

Parameter

Name	Typ	Bedeutung
`id`im Pfad	`string`Pflicht	Die `id` eines Beitrags.
`limit`in der Adresse	`integer`freiwillig	Wie viele Einträge eine Seite hält: 20 als Vorgabe, höchstens 50.
`cursor`in der Adresse	`string`freiwillig	Wo es weitergeht: das `next` der vorigen Antwort. Ohne ihn von oben.

Beispielanfrage

curl \
  -H "Authorization: Bearer tm_key_…" \
  "https://tellmelo.com/api/v2/posts/5f0c2a9e-8d41-4b7a-9c3e-2e61d0f4a7b1/replies?limit=20"

Antwort

Antwortet mit einer Seite von Reply, als `items` und `next`.

Beispiel

{
  "items": [
    {
      "id": "9e4b1c7d-2a3f-4d5e-8b6c-0f1e2d3c4b5a",
      "text": "Same here, the lavender is full of them.",
      "kind": "post",
      "author": {
        "id": "d4c3b2a1-6e5f-4a7b-9c8d-1e2f3a4b5c6d",
        "handle": "jon",
        "name": "Jon",
        "verified": false,
        "accountKind": "person"
      },
      "community": null,
      "media": [],
      "poll": null,
      "quotes": null,
      "continues": null,
      "counts": {
        "replies": 0,
        "likes": 3,
        "reposts": 0
      },
      "pinned": false,
      "createdAt": 1758624600000,
      "postId": "5f0c2a9e-8d41-4b7a-9c3e-2e61d0f4a7b1",
      "parentId": null
    }
  ],
  "next": "MTc1ODYyNDAwMDAwMDo1ZjBjMmE5ZS04ZDQx"
}

Mögliche Status: 200304400401404429

POST`/api/v2/posts/{id}/replies`

Auf einen Beitrag antworten.

Recht write
seit v2.0

Steht der Beitrag im langsamen Modus, ist eine Antwort pro Person alle 10 Minuten möglich; eine weitere ergibt 429 mit der Wartezeit in der Meldung. Der Modus gilt nicht für den Verfasser und die Konten, denen er folgt.

Parameter

Name	Typ	Bedeutung
`id`im Pfad	`string`Pflicht	Die `id` eines Beitrags.
`text`im Körper	`string`Pflicht	Der Text selbst: des Beitrags, der Antwort oder der Nachricht.
`parentId`im Körper	`string`freiwillig	Die `id` der Antwort, auf die diese antwortet. Ohne sie direkt an den Beitrag.

Beispielanfrage

curl -X POST \
  -H "Authorization: Bearer tm_key_…" \
  -H "Content-Type: application/json" \
  -d '{"text":"Same here, the lavender is full of them."}' \
  "https://tellmelo.com/api/v2/posts/5f0c2a9e-8d41-4b7a-9c3e-2e61d0f4a7b1/replies"

Antwort

Antwortet mit einem Created.

Beispiel

{
  "id": "5f0c2a9e-8d41-4b7a-9c3e-2e61d0f4a7b1",
  "scheduledFor": null,
  "deleteAt": null
}

Mögliche Status: 200400401403404429

Umfragen

Eine Umfrage ist ein Beitrag, dessen poll gesetzt ist. Abstimmen hat einen eigenen Pfad.

POST`/api/v2/posts/{id}/vote`

An einer Umfrage teilnehmen.

Recht write
seit v2.0

Die Stimmen je Antwort sind null, solange das Ergebnis zurückgehalten wird: vor deiner eigenen Stimme, während die Umfrage läuft. total ist immer da.

Parameter

Name	Typ	Bedeutung
`id`im Pfad	`string`Pflicht	Die `id` eines Beitrags.
`option`im Körper	`integer`Pflicht	Welche Antwort, ab 0 gezählt. Eine je Aufruf. Eine Umfrage mit mehreren Antworten wird durch mehrfaches Aufrufen gewählt.
`retract`im Körper	`boolean`freiwillig	Ob diese Stimme zurückgenommen wird: `true` macht sie rückgängig.

Beispielanfrage

curl -X POST \
  -H "Authorization: Bearer tm_key_…" \
  -H "Content-Type: application/json" \
  -d '{"option":0}' \
  "https://tellmelo.com/api/v2/posts/5f0c2a9e-8d41-4b7a-9c3e-2e61d0f4a7b1/vote"

Antwort

Antwortet mit einem Ok.

Beispiel

{
  "ok": true
}

Mögliche Status: 200400401403404429

Profile

Öffentliche Profile über ihren Kurznamen, und was sie gepostet haben.

GET`/api/v2/profiles/{handle}`

Ein Profil, über sein Kürzel.

Recht read
mit ETag
seit v2.0

Parameter

Name	Typ	Bedeutung
`handle`im Pfad	`string`Pflicht	Das Kürzel eines Profils.

Beispielanfrage

curl \
  -H "Authorization: Bearer tm_key_…" \
  "https://tellmelo.com/api/v2/profiles/mara"

Antwort

Antwortet mit einem Profile.

Beispiel

{
  "id": "a3e1f7c2-54b9-4d0e-8f16-7b2c9d4e1a05",
  "handle": "mara",
  "name": "Mara 🌻",
  "verified": true,
  "accountKind": "person",
  "about": "Beekeeper, allotment, too many seeds. :tellmelo:",
  "website": "https://mara-imkerei.example/",
  "websiteVerified": true,
  "followers": 148,
  "createdAt": 1750848000000
}

Mögliche Status: 200304400401404429

GET`/api/v2/profiles/{handle}/posts`

Die öffentlichen Beiträge eines Profils, neueste zuerst.

Recht read
blätterbar
mit ETag
seit v2.0

Auf den öffentlichen Pfaden werden Reaktionen nicht gezählt: counts.likes und counts.reposts sind 0 und pinned ist false (ein Ausschnitt, keine Messung).

Beiträge in einer Community erreichst du hier nicht, weder in der Liste noch über ihre id. Sie stehen unter /communities/{id}/posts.

Parameter

Name	Typ	Bedeutung
`handle`im Pfad	`string`Pflicht	Das Kürzel eines Profils.
`limit`in der Adresse	`integer`freiwillig	Wie viele Einträge eine Seite hält: 20 als Vorgabe, höchstens 50.
`cursor`in der Adresse	`string`freiwillig	Wo es weitergeht: das `next` der vorigen Antwort. Ohne ihn von oben.

Beispielanfrage

curl \
  -H "Authorization: Bearer tm_key_…" \
  "https://tellmelo.com/api/v2/profiles/mara/posts?limit=20"

Antwort

Antwortet mit einer Seite von Post, als `items` und `next`.

Beispiel

{
  "items": [
    {
      "id": "5f0c2a9e-8d41-4b7a-9c3e-2e61d0f4a7b1",
      "text": "The bees are back in the garden 🐝 #garden",
      "kind": "poll",
      "author": {
        "id": "a3e1f7c2-54b9-4d0e-8f16-7b2c9d4e1a05",
        "handle": "mara",
        "name": "Mara 🌻",
        "verified": true,
        "accountKind": "person"
      },
      "community": {
        "id": "c81d4e2a-0f3b-4a6c-9e57-1d2b3c4a5f60",
        "name": "Urban Gardening"
      },
      "media": [
        {
          "url": "/api/media?id=b2d7e9f1-3c4a-4e8b-a1f0-6d5c4b3a2918"
        }
      ],
      "poll": {
        "options": [
          {
            "text": "Lavender",
            "votes": 12
          },
          {
            "text": "Sunflowers",
            "votes": 7
          },
          {
            "text": "Clover",
            "votes": 3
          }
        ],
        "total": 22,
        "multiple": false,
        "endsAt": 1758710400000,
        "running": true,
        "resultsVisible": true,
        "myVotes": [
          0
        ]
      },
      "quotes": null,
      "continues": null,
      "counts": {
        "replies": 4,
        "likes": 31,
        "reposts": 2
      },
      "pinned": false,
      "createdAt": 1758624000000
    }
  ],
  "next": "MTc1ODYyNDAwMDAwMDo1ZjBjMmE5ZS04ZDQx"
}

Mögliche Status: 200304400401404429

Communities

Die offenen Communities dieser Instanz und ihre Beiträge. Interne und verborgene sind mit einem Schlüssel nicht erreichbar.

GET`/api/v2/communities`

Die offenen Communities dieser Instanz.

Recht read
mit ETag
seit v2.0

Sortiert nach der Zahl der Mitglieder, nicht nach der Zeit, deshalb wird diese Liste nicht geblättert, und next ist immer null.

Parameter

Name	Typ	Bedeutung
`limit`in der Adresse	`integer`freiwillig	Wie viele Einträge eine Seite hält: 20 als Vorgabe, höchstens 50.

Beispielanfrage

curl \
  -H "Authorization: Bearer tm_key_…" \
  "https://tellmelo.com/api/v2/communities?limit=20"

Antwort

Antwortet mit einer Seite von Community, als `items` und `next`.

Beispiel

{
  "items": [
    {
      "id": "c81d4e2a-0f3b-4a6c-9e57-1d2b3c4a5f60",
      "name": "Urban Gardening",
      "description": "Balconies, allotments, rooftops: whatever grows.",
      "tags": [
        "garden",
        "bees"
      ],
      "members": 312,
      "joinPolicy": "open",
      "visibility": "open"
    }
  ],
  "next": null
}

Mögliche Status: 200304401429

GET`/api/v2/communities/{id}`

Eine einzelne Community, über ihre id.

Recht read
mit ETag
seit v2.0

Parameter

Name	Typ	Bedeutung
`id`im Pfad	`string`Pflicht	Die `id` einer Community.

Beispielanfrage

curl \
  -H "Authorization: Bearer tm_key_…" \
  "https://tellmelo.com/api/v2/communities/c81d4e2a-0f3b-4a6c-9e57-1d2b3c4a5f60"

Antwort

Antwortet mit einem Community.

Beispiel

{
  "id": "c81d4e2a-0f3b-4a6c-9e57-1d2b3c4a5f60",
  "name": "Urban Gardening",
  "description": "Balconies, allotments, rooftops: whatever grows.",
  "tags": [
    "garden",
    "bees"
  ],
  "members": 312,
  "joinPolicy": "open",
  "visibility": "open"
}

Mögliche Status: 200304400401404429

GET`/api/v2/communities/{id}/posts`

Die öffentlichen Beiträge aus einer Community, neueste zuerst.

Recht read
blätterbar
mit ETag
seit v2.0

Auf den öffentlichen Pfaden werden Reaktionen nicht gezählt: counts.likes und counts.reposts sind 0 und pinned ist false (ein Ausschnitt, keine Messung).

Parameter

Name	Typ	Bedeutung
`id`im Pfad	`string`Pflicht	Die `id` einer Community.
`limit`in der Adresse	`integer`freiwillig	Wie viele Einträge eine Seite hält: 20 als Vorgabe, höchstens 50.
`cursor`in der Adresse	`string`freiwillig	Wo es weitergeht: das `next` der vorigen Antwort. Ohne ihn von oben.

Beispielanfrage

curl \
  -H "Authorization: Bearer tm_key_…" \
  "https://tellmelo.com/api/v2/communities/c81d4e2a-0f3b-4a6c-9e57-1d2b3c4a5f60/posts?limit=20"

Antwort

Antwortet mit einer Seite von Post, als `items` und `next`.

Beispiel

{
  "items": [
    {
      "id": "5f0c2a9e-8d41-4b7a-9c3e-2e61d0f4a7b1",
      "text": "The bees are back in the garden 🐝 #garden",
      "kind": "poll",
      "author": {
        "id": "a3e1f7c2-54b9-4d0e-8f16-7b2c9d4e1a05",
        "handle": "mara",
        "name": "Mara 🌻",
        "verified": true,
        "accountKind": "person"
      },
      "community": {
        "id": "c81d4e2a-0f3b-4a6c-9e57-1d2b3c4a5f60",
        "name": "Urban Gardening"
      },
      "media": [
        {
          "url": "/api/media?id=b2d7e9f1-3c4a-4e8b-a1f0-6d5c4b3a2918"
        }
      ],
      "poll": {
        "options": [
          {
            "text": "Lavender",
            "votes": 12
          },
          {
            "text": "Sunflowers",
            "votes": 7
          },
          {
            "text": "Clover",
            "votes": 3
          }
        ],
        "total": 22,
        "multiple": false,
        "endsAt": 1758710400000,
        "running": true,
        "resultsVisible": true,
        "myVotes": [
          0
        ]
      },
      "quotes": null,
      "continues": null,
      "counts": {
        "replies": 4,
        "likes": 31,
        "reposts": 2
      },
      "pinned": false,
      "createdAt": 1758624000000
    }
  ],
  "next": "MTc1ODYyNDAwMDAwMDo1ZjBjMmE5ZS04ZDQx"
}

Mögliche Status: 200304400401404429

Entdecken

Worüber gerade gesprochen wird, eine Suche über Beiträge, Profile und Tags, und die eigenen Emojis der Instanz.

GET`/api/v2/tags`

Die Tags, die gerade laufen.

Recht read
mit ETag
seit v2.0

Die Tags, die gerade laufen, die meisten Beiträge zuerst. Nicht blätterbar: limit kürzt nur die Liste.

Parameter

Name	Typ	Bedeutung
`limit`in der Adresse	`integer`freiwillig	Wie viele Einträge eine Seite hält: 20 als Vorgabe, höchstens 50.

Beispielanfrage

curl \
  -H "Authorization: Bearer tm_key_…" \
  "https://tellmelo.com/api/v2/tags?limit=10"

Antwort

Antwortet mit einer Seite von Tag, als `items` und `next`.

Beispiel

{
  "items": [
    {
      "tag": "garden",
      "posts": 58
    }
  ],
  "next": null
}

Mögliche Status: 200304401429

GET`/api/v2/search`

Eine Suche über Beiträge, Namen, Kürzel und Tags.

Recht read
mit ETag
seit v2.0

Sucht nur im Öffentlichen: Beiträge außerhalb von Communities, Profile und Tags. limit zählt je Art: 20 kann bis zu 20 Beiträge, 20 Profile und 20 Tags bringen.

Parameter

Name	Typ	Bedeutung
`q`in der Adresse	`string`Pflicht	Die Wörter, nach denen gesucht wird.
`type`in der Adresse	`string`freiwillig	Welche Art von Treffer. Ohne ihn jede Art.`allpostsprofilestags`
`limit`in der Adresse	`integer`freiwillig	Wie viele Einträge eine Seite hält: 20 als Vorgabe, höchstens 50.

Beispielanfrage

curl \
  -H "Authorization: Bearer tm_key_…" \
  "https://tellmelo.com/api/v2/search?q=garden&type=posts"

Antwort

Antwortet mit einem SearchResult.

Beispiel

{
  "posts": [
    {
      "id": "5f0c2a9e-8d41-4b7a-9c3e-2e61d0f4a7b1",
      "text": "The bees are back in the garden 🐝 #garden",
      "kind": "poll",
      "author": {
        "id": "a3e1f7c2-54b9-4d0e-8f16-7b2c9d4e1a05",
        "handle": "mara",
        "name": "Mara 🌻",
        "verified": true,
        "accountKind": "person"
      },
      "community": {
        "id": "c81d4e2a-0f3b-4a6c-9e57-1d2b3c4a5f60",
        "name": "Urban Gardening"
      },
      "media": [
        {
          "url": "/api/media?id=b2d7e9f1-3c4a-4e8b-a1f0-6d5c4b3a2918"
        }
      ],
      "poll": {
        "options": [
          {
            "text": "Lavender",
            "votes": 12
          },
          {
            "text": "Sunflowers",
            "votes": 7
          },
          {
            "text": "Clover",
            "votes": 3
          }
        ],
        "total": 22,
        "multiple": false,
        "endsAt": 1758710400000,
        "running": true,
        "resultsVisible": true,
        "myVotes": [
          0
        ]
      },
      "quotes": null,
      "continues": null,
      "counts": {
        "replies": 4,
        "likes": 31,
        "reposts": 2
      },
      "pinned": false,
      "createdAt": 1758624000000
    }
  ],
  "profiles": [
    {
      "id": "a3e1f7c2-54b9-4d0e-8f16-7b2c9d4e1a05",
      "handle": "mara",
      "name": "Mara 🌻",
      "verified": true,
      "accountKind": "person"
    }
  ],
  "tags": [
    {
      "tag": "garden",
      "posts": 58
    }
  ]
}

Mögliche Status: 200304400401429

GET`/api/v2/emojis`

Die eigenen Emojis der Instanz, mit der Adresse ihrer Bilder.

Recht read
mit ETag
seit v2.1

In Texten steht ein Emoji dieser Instanz als :name:. Ersetz es durch das Bild aus dieser Liste; ein Name, der nicht darin steht, bleibt Text. Er wurde gelöscht oder hat nie existiert.

Beispielanfrage

curl \
  -H "Authorization: Bearer tm_key_…" \
  "https://tellmelo.com/api/v2/emojis"

Antwort

Antwortet mit einer Seite von Emoji, als `items` und `next`.

Beispiel

{
  "items": [
    {
      "name": "tellmelo",
      "url": "/api/media?id=e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
    }
  ],
  "next": null
}

Mögliche Status: 200304401429

Dein Konto

Dein eigenes Profil und dein Feed, so zusammengestellt, wie die Anwendung es für dich tut.

GET`/api/v2/me`

Dein eigenes Profil, mit der id, die die anderen Wege erwarten.

Recht read
mit ETag
seit v2.0

Beispielanfrage

curl \
  -H "Authorization: Bearer tm_key_…" \
  "https://tellmelo.com/api/v2/me"

Antwort

Antwortet mit einem Profile.

Beispiel

{
  "id": "a3e1f7c2-54b9-4d0e-8f16-7b2c9d4e1a05",
  "handle": "mara",
  "name": "Mara 🌻",
  "verified": true,
  "accountKind": "person",
  "about": "Beekeeper, allotment, too many seeds. :tellmelo:",
  "website": "https://mara-imkerei.example/",
  "websiteVerified": true,
  "followers": 148,
  "createdAt": 1750848000000
}

Mögliche Status: 200304401429

GET`/api/v2/feed`

Dein eigener Feed, so wie die Anwendung ihn zusammenstellt.

Recht read
blätterbar
seit v2.0

Hier gibt es kein ETag: Die Reihenfolge bewegt sich mit der Zeit, jede Antwort ist also anders. Eine begonnene Liste bleibt trotzdem bis zu ihrem Ende gleich: next trägt den Moment, in dem sie begann.

Parameter

Name	Typ	Bedeutung
`tab`in der Adresse	`string`freiwillig	Welcher Feed: `for-you`, `following`, `latest` oder `bookmarks`. `latest` als Vorgabe.`for-youfollowinglatestbookmarks`
`tag`in der Adresse	`string`freiwillig	Nur Beiträge mit diesem Tag. Ohne ihn kein Filter.
`limit`in der Adresse	`integer`freiwillig	Wie viele Einträge eine Seite hält: 20 als Vorgabe, höchstens 50.
`cursor`in der Adresse	`string`freiwillig	Wo es weitergeht: das `next` der vorigen Antwort. Ohne ihn von oben.

Beispielanfrage

curl \
  -H "Authorization: Bearer tm_key_…" \
  "https://tellmelo.com/api/v2/feed?tab=following&limit=20"

Antwort

Antwortet mit einer Seite von Post, als `items` und `next`.

Beispiel

{
  "items": [
    {
      "id": "5f0c2a9e-8d41-4b7a-9c3e-2e61d0f4a7b1",
      "text": "The bees are back in the garden 🐝 #garden",
      "kind": "poll",
      "author": {
        "id": "a3e1f7c2-54b9-4d0e-8f16-7b2c9d4e1a05",
        "handle": "mara",
        "name": "Mara 🌻",
        "verified": true,
        "accountKind": "person"
      },
      "community": {
        "id": "c81d4e2a-0f3b-4a6c-9e57-1d2b3c4a5f60",
        "name": "Urban Gardening"
      },
      "media": [
        {
          "url": "/api/media?id=b2d7e9f1-3c4a-4e8b-a1f0-6d5c4b3a2918"
        }
      ],
      "poll": {
        "options": [
          {
            "text": "Lavender",
            "votes": 12
          },
          {
            "text": "Sunflowers",
            "votes": 7
          },
          {
            "text": "Clover",
            "votes": 3
          }
        ],
        "total": 22,
        "multiple": false,
        "endsAt": 1758710400000,
        "running": true,
        "resultsVisible": true,
        "myVotes": [
          0
        ]
      },
      "quotes": null,
      "continues": null,
      "counts": {
        "replies": 4,
        "likes": 31,
        "reposts": 2
      },
      "pinned": false,
      "createdAt": 1758624000000
    }
  ],
  "next": "MTc1ODYyNDAwMDAwMDo1ZjBjMmE5ZS04ZDQx"
}

Mögliche Status: 200400401429

Mitteilungen

Was rund um dein Konto passiert ist, seitenweise lesbar, damit ein Programm nachholen kann, was es verpasst hat.

GET`/api/v2/notifications`

Deine eigenen Mitteilungen, neueste zuerst, blätterbar, damit ein Programm nachholen kann, was es verpasst hat.

Recht read
blätterbar
mit ETag
seit v2.0

Lesen markiert nichts als gelesen; das tut POST /notifications/read. Mehrere Ereignisse derselben Art zum selben Beitrag werden in einer Zeile gesammelt, und more sagt, wie viele.

Parameter

Name	Typ	Bedeutung
`limit`in der Adresse	`integer`freiwillig	Wie viele Einträge eine Seite hält: 20 als Vorgabe, höchstens 50.
`cursor`in der Adresse	`string`freiwillig	Wo es weitergeht: das `next` der vorigen Antwort. Ohne ihn von oben.

Beispielanfrage

curl \
  -H "Authorization: Bearer tm_key_…" \
  "https://tellmelo.com/api/v2/notifications?limit=20"

Antwort

Antwortet mit einer Seite von Notification, als `items` und `next`.

Beispiel

{
  "items": [
    {
      "id": "3f2e1d0c-9b8a-4765-8432-10fedcba9876",
      "kind": "like",
      "text": null,
      "actor": {
        "handle": "jon",
        "name": "Jon"
      },
      "postId": "5f0c2a9e-8d41-4b7a-9c3e-2e61d0f4a7b1",
      "read": false,
      "more": 2,
      "createdAt": 1758624300000,
      "updatedAt": 1758624900000
    }
  ],
  "next": "MTc1ODYyNDAwMDAwMDo1ZjBjMmE5ZS04ZDQx"
}

Mögliche Status: 200304401429

POST`/api/v2/notifications/read`

Deine Mitteilungen als gelesen markieren.

Recht write
seit v2.0

Beispielanfrage

curl -X POST \
  -H "Authorization: Bearer tm_key_…" \
  "https://tellmelo.com/api/v2/notifications/read"

Antwort

Antwortet mit einem Ok.

Beispiel

{
  "ok": true
}

Mögliche Status: 200401403429

Nachrichten

Dein Postfach und deine Unterhaltungen. Eine Unterhaltung hat keine eigene ID; sie heißt nach dem anderen Konto.

GET`/api/v2/conversations`

Dein Postfach: eine Zeile je Gespräch, das jüngste zuerst.

Recht read
blätterbar
mit ETag
seit v2.0

Parameter

Name	Typ	Bedeutung
`limit`in der Adresse	`integer`freiwillig	Wie viele Einträge eine Seite hält: 20 als Vorgabe, höchstens 50.
`cursor`in der Adresse	`string`freiwillig	Wo es weitergeht: das `next` der vorigen Antwort. Ohne ihn von oben.

Beispielanfrage

curl \
  -H "Authorization: Bearer tm_key_…" \
  "https://tellmelo.com/api/v2/conversations?limit=20"

Antwort

Antwortet mit einer Seite von Conversation, als `items` und `next`.

Beispiel

{
  "items": [
    {
      "with": "d4c3b2a1-6e5f-4a7b-9c8d-1e2f3a4b5c6d",
      "handle": "jon",
      "name": "Jon",
      "excerpt": "See you on Saturday at the market!",
      "truncated": false,
      "fromMe": true,
      "lastMessageId": "7c6b5a49-3827-4165-9f0e-d1c2b3a49586",
      "unread": 0,
      "updatedAt": 1758624060000
    }
  ],
  "next": "MTc1ODYyNDAwMDAwMDo1ZjBjMmE5ZS04ZDQx"
}

Mögliche Status: 200304401429

GET`/api/v2/conversations/{with}/messages`

Die Nachrichten eines Gesprächs, neueste zuerst.

Recht read
blätterbar
mit ETag
seit v2.0

Lesen markiert nichts als gelesen. Ein Programm, das im Hintergrund abruft, hat niemandem etwas gezeigt. Das tut POST /conversations/{with}/read.

Parameter

Name	Typ	Bedeutung
`with`im Pfad	`string`Pflicht	Die `id` des Kontos, mit dem du sprichst. Ein Gespräch hat keine eigene `id`. Es ist das andere Konto, derselbe Wert, den das Postfach `with` nennt.
`limit`in der Adresse	`integer`freiwillig	Wie viele Einträge eine Seite hält: 20 als Vorgabe, höchstens 50.
`cursor`in der Adresse	`string`freiwillig	Wo es weitergeht: das `next` der vorigen Antwort. Ohne ihn von oben.

Beispielanfrage

curl \
  -H "Authorization: Bearer tm_key_…" \
  "https://tellmelo.com/api/v2/conversations/a3e1f7c2-54b9-4d0e-8f16-7b2c9d4e1a05/messages?limit=20"

Antwort

Antwortet mit einer Seite von Message, als `items` und `next`.

Beispiel

{
  "items": [
    {
      "id": "7c6b5a49-3827-4165-9f0e-d1c2b3a49586",
      "text": "See you on Saturday at the market!",
      "from": "a3e1f7c2-54b9-4d0e-8f16-7b2c9d4e1a05",
      "to": "d4c3b2a1-6e5f-4a7b-9c8d-1e2f3a4b5c6d",
      "read": true,
      "media": [],
      "replyTo": null,
      "createdAt": 1758624060000
    }
  ],
  "next": "MTc1ODYyNDAwMDAwMDo1ZjBjMmE5ZS04ZDQx"
}

Mögliche Status: 200304400401404429

POST`/api/v2/conversations/{with}/messages`

Eine Nachricht in einem Gespräch senden.

Recht write
seit v2.0

Es gelten dieselben Regeln wie in der Anwendung: Wer dich blockiert hat, ist nicht erreichbar, und die Einstellungen der anderen Person zählen. Die Antwort sagt dann, warum.

Bilder lassen sich über die API noch nicht anhängen, nur in der Anwendung.

Parameter

Name	Typ	Bedeutung
`with`im Pfad	`string`Pflicht	Die `id` des Kontos, mit dem du sprichst. Ein Gespräch hat keine eigene `id`. Es ist das andere Konto, derselbe Wert, den das Postfach `with` nennt.
`text`im Körper	`string`Pflicht	Der Text selbst: des Beitrags, der Antwort oder der Nachricht.
`replyTo`im Körper	`string`freiwillig	Die `id` einer früheren Nachricht dieses Gesprächs, auf die diese antwortet. Seit 2.2.

Beispielanfrage

curl -X POST \
  -H "Authorization: Bearer tm_key_…" \
  -H "Content-Type: application/json" \
  -d '{"text":"See you on Saturday at the market!"}' \
  "https://tellmelo.com/api/v2/conversations/a3e1f7c2-54b9-4d0e-8f16-7b2c9d4e1a05/messages"

Antwort

Antwortet mit einem Ok.

Beispiel

{
  "ok": true
}

Mögliche Status: 200400401403404429

POST`/api/v2/conversations/{with}/read`

Alle Nachrichten einer Unterhaltung als gelesen markieren.

Recht write
seit v2.1

Parameter

Name	Typ	Bedeutung
`with`im Pfad	`string`Pflicht	Die `id` des Kontos, mit dem du sprichst. Ein Gespräch hat keine eigene `id`. Es ist das andere Konto, derselbe Wert, den das Postfach `with` nennt.

Beispielanfrage

curl -X POST \
  -H "Authorization: Bearer tm_key_…" \
  "https://tellmelo.com/api/v2/conversations/a3e1f7c2-54b9-4d0e-8f16-7b2c9d4e1a05/read"

Antwort

Antwortet mit einem Ok.

Beispiel

{
  "ok": true
}

Mögliche Status: 200400401403404429

Beziehungen

Gefällt mir, merken, teilen, folgen, beitreten und blockieren: ein Pfad für alles, gesetzt und zurückgenommen mit active.

POST`/api/v2/relations`

Mögen, merken, teilen, folgen, beitreten, blockieren, stummschalten, je nach kind.

Recht write
seit v2.0

target ist bei like, save und repost ein Beitrag, bei join eine Community, bei follow, block und mute ein Konto, immer über seine id. active: false nimmt die Beziehung zurück. Über eine Blockierung hinweg folgt niemand, in keine Richtung. Stummschalten sieht nur, wer es setzt.

Parameter

Name	Typ	Bedeutung
`kind`im Körper	`string`Pflicht	Welche Beziehung: `like`, `save`, `repost`, `follow`, `join`, `block` oder `mute` (seit 2.2).`likesaverepostfollowjoinblockmute`
`target`im Körper	`string`Pflicht	Worauf die Beziehung zeigt, über dessen `id`: ein Beitrag, ein Profil oder eine Community, je nach `kind`.
`active`im Körper	`boolean`freiwillig	Ob die Beziehung bestehen soll: `true` setzt sie, `false` nimmt sie zurück.

Beispielanfrage

curl -X POST \
  -H "Authorization: Bearer tm_key_…" \
  -H "Content-Type: application/json" \
  -d '{"kind":"like","target":"5f0c2a9e-8d41-4b7a-9c3e-2e61d0f4a7b1","active":true}' \
  "https://tellmelo.com/api/v2/relations"

Antwort

Antwortet mit einem Ok.

Beispiel

{
  "ok": true
}

Mögliche Status: 200400401403429

Objekte

Alles, was in einer Antwort stehen kann, Feld für Feld. Jedes Feld ist immer vorhanden; die Typen sind JSON-Typen, und [] heißt Liste.

`Service`

Die Antwort der Wurzel: wer antwortet, und was dieser Schlüssel darf.

Feld	Typ	Bedeutung
`name`	`string`	Immer `tellmelo`.
`version`	`string`	Die Version der API, zum Beispiel `2.1`.
`scope`	`string`	Was dieser Schlüssel darf: `read` oder `read write`.
`rateLimit`	`RateLimit`	Das Kontingent dieses Schlüssels.
`docs`	`string`	Wo diese Dokumentation steht, als Pfad auf dieser Instanz.
`spec`	`string`	Wo die maschinenlesbare Beschreibung steht.

Beispiel

{
  "name": "tellmelo",
  "version": "2.6",
  "scope": "read write",
  "rateLimit": {
    "limit": 120,
    "remaining": 117
  },
  "docs": "/legal/api",
  "spec": "/api/v2/openapi.json"
}

`RateLimit`

Das Kontingent dieses Schlüssels in der laufenden Minute.

Feld	Typ	Bedeutung
`limit`	`integer`	Anfragen pro Minute.
`remaining`	`integer`	Wie viele in dieser Minute übrig sind.

Beispiel

{
  "limit": 120,
  "remaining": 117
}

`Post`

Ein Beitrag: überall dieselbe Form, ob öffentlich, aus deinem Feed oder aus einer Suche.

Feld	Typ	Bedeutung
`id`	`string`	Die ID des Beitrags.
`text`	`string`oder null	Der Text, wie geschrieben (`null` bei einem Beitrag, der nur Umfrage oder nur Bilder ist).
`kind`	`string`	Was der Beitrag ist. `post` — Ein Beitrag mit Text, Bildern oder einem Zitat. `poll` — Ein Beitrag mit einer Umfrage.
`author`	`ProfileBrief`	Wer ihn geschrieben hat.
`community`	`CommunityBrief`oder null	Die Community, in der er geschrieben wurde (`null` außerhalb jeder Community).
`media`	`Media[]`	Seine Bilder, in Reihenfolge; leer, wenn es keine gibt.
`poll`	`Poll`oder null	Die Umfrage (`null`, wenn es keine gibt).
`quotes`	`string`oder null	Die ID des Beitrags, den dieser zitiert.
`continues`	`string`oder null	Die ID des Beitrags, den dieser als Nachtrag fortsetzt.
`counts`	`Counts`	Antworten, Gefällt-mir und Reposts.
`pinned`	`boolean`	Ob er oben im Profil seines Verfassers angeheftet ist.
`createdAt`	`integer`	Wann er geschrieben wurde.

Beispiel

{
  "id": "5f0c2a9e-8d41-4b7a-9c3e-2e61d0f4a7b1",
  "text": "The bees are back in the garden 🐝 #garden",
  "kind": "poll",
  "author": {
    "id": "a3e1f7c2-54b9-4d0e-8f16-7b2c9d4e1a05",
    "handle": "mara",
    "name": "Mara 🌻",
    "verified": true,
    "accountKind": "person"
  },
  "community": {
    "id": "c81d4e2a-0f3b-4a6c-9e57-1d2b3c4a5f60",
    "name": "Urban Gardening"
  },
  "media": [
    {
      "url": "/api/media?id=b2d7e9f1-3c4a-4e8b-a1f0-6d5c4b3a2918"
    }
  ],
  "poll": {
    "options": [
      {
        "text": "Lavender",
        "votes": 12
      },
      {
        "text": "Sunflowers",
        "votes": 7
      },
      {
        "text": "Clover",
        "votes": 3
      }
    ],
    "total": 22,
    "multiple": false,
    "endsAt": 1758710400000,
    "running": true,
    "resultsVisible": true,
    "myVotes": [
      0
    ]
  },
  "quotes": null,
  "continues": null,
  "counts": {
    "replies": 4,
    "likes": 31,
    "reposts": 2
  },
  "pinned": false,
  "createdAt": 1758624000000
}

`Reply`

Eine Antwort unter einem Beitrag: ein Beitrag mit zwei Feldern mehr.

Jedes Feld von Post, und dazu:

Feld	Typ	Bedeutung
`postId`	`string`	Der Beitrag, an dem das ganze Gespräch hängt.
`parentId`	`string`oder null	Die Antwort, auf die diese antwortet (`null`, wenn sie direkt auf den Beitrag antwortet).

Beispiel

{
  "id": "9e4b1c7d-2a3f-4d5e-8b6c-0f1e2d3c4b5a",
  "text": "Same here, the lavender is full of them.",
  "kind": "post",
  "author": {
    "id": "d4c3b2a1-6e5f-4a7b-9c8d-1e2f3a4b5c6d",
    "handle": "jon",
    "name": "Jon",
    "verified": false,
    "accountKind": "person"
  },
  "community": null,
  "media": [],
  "poll": null,
  "quotes": null,
  "continues": null,
  "counts": {
    "replies": 0,
    "likes": 3,
    "reposts": 0
  },
  "pinned": false,
  "createdAt": 1758624600000,
  "postId": "5f0c2a9e-8d41-4b7a-9c3e-2e61d0f4a7b1",
  "parentId": null
}

`Counts`

Wie viele Antworten, Gefällt-mir und Reposts ein Beitrag hat.

Feld	Typ	Bedeutung
`replies`	`integer`	Antworten, alle Ebenen zusammen.
`likes`	`integer`	Gefällt-mir.
`reposts`	`integer`	Reposts.

Beispiel

{
  "replies": 4,
  "likes": 31,
  "reposts": 2
}

`Media`

Ein Bild eines Beitrags oder einer Nachricht.

Feld	Typ	Bedeutung
`url`	`string`	Die Adresse des Bildes, relativ zu dieser Instanz. Lad es mit dem Schlüssel im Header.

Beispiel

{
  "url": "/api/media?id=b2d7e9f1-3c4a-4e8b-a1f0-6d5c4b3a2918"
}

`Poll`

Die Umfrage eines Beitrags.

Feld	Typ	Bedeutung
`options`	`PollOption[]`	Die Antworten, in Reihenfolge. `option` beim Abstimmen zählt ab 0.
`total`	`integer`	Wie viele Stimmen es insgesamt gibt: immer, auch während die Verteilung zurückgehalten wird.
`multiple`	`boolean`	Ob mehr als eine Antwort gewählt werden darf.
`endsAt`	`integer`oder null	Wann die Umfrage endet (`null`, wenn sie ohne Ende läuft).
`running`	`boolean`	Ob noch abgestimmt werden kann.
`resultsVisible`	`boolean`	Ob die Stimmen je Antwort gezeigt werden (siehe `votes`).
`myVotes`	`integer[]`	Die Antworten, die du gewählt hast, ab 0 gezählt.

Beispiel

{
  "options": [
    {
      "text": "Lavender",
      "votes": 12
    },
    {
      "text": "Sunflowers",
      "votes": 7
    },
    {
      "text": "Clover",
      "votes": 3
    }
  ],
  "total": 22,
  "multiple": false,
  "endsAt": 1758710400000,
  "running": true,
  "resultsVisible": true,
  "myVotes": [
    0
  ]
}

`PollOption`

Eine Antwort einer Umfrage.

Feld	Typ	Bedeutung
`text`	`string`	Die Antwort.
`votes`	`integer`oder null	Ihre Stimmen (`null`, solange das Ergebnis zurückgehalten wird).

Beispiel

{
  "text": "Lavender",
  "votes": 12
}

`ProfileBrief`

Ein Profil, wie es in anderen Objekten erscheint: als Verfasser, in einer Suche.

Feld	Typ	Bedeutung
`id`	`string`	Die ID des Kontos: das, was `/relations` und `/conversations/{with}` erwarten.
`handle`	`string`	Der Kurzname, ohne `@`. Er ist Teil der Profiladresse und kann keine Emojis enthalten.
`name`	`string`	Der Anzeigename. Er kann Emojis enthalten, auch `:name:`.
`verified`	`boolean`	Ob das Konto verifiziert ist.
`accountKind`	`string`	Was für ein Konto es ist. `person` — Eine Person. `business` — Ein Unternehmen. `association` — Ein Verein. `automated` — Ein automatisiertes Konto, etwa ein Bot.

Beispiel

{
  "id": "a3e1f7c2-54b9-4d0e-8f16-7b2c9d4e1a05",
  "handle": "mara",
  "name": "Mara 🌻",
  "verified": true,
  "accountKind": "person"
}

`Profile`

Ein Profil für sich, mit Beschreibung und Folgenden.

Jedes Feld von ProfileBrief, und dazu:

Feld	Typ	Bedeutung
`about`	`string`oder null	Die Beschreibung (`null`, wenn es keine gibt).
`website`	`string`oder null	Die Website des Profils (`null`, wenn es keine gibt). Seit 2.3.
`websiteVerified`	`boolean`	Ob die Website mit `rel=me` auf dieses Profil zurückverlinkt, zuletzt geprüft innerhalb einer Woche. Seit 2.3.
`followers`	`integer`	Wie viele Konten ihm folgen.
`createdAt`	`integer`	Wann das Konto angelegt wurde.

Beispiel

{
  "id": "a3e1f7c2-54b9-4d0e-8f16-7b2c9d4e1a05",
  "handle": "mara",
  "name": "Mara 🌻",
  "verified": true,
  "accountKind": "person",
  "about": "Beekeeper, allotment, too many seeds. :tellmelo:",
  "website": "https://mara-imkerei.example/",
  "websiteVerified": true,
  "followers": 148,
  "createdAt": 1750848000000
}

`CommunityBrief`

Die Community, in der ein Beitrag geschrieben wurde.

Feld	Typ	Bedeutung
`id`	`string`	Die ID der Community.
`name`	`string`oder null	Ihr Name.

Beispiel

{
  "id": "c81d4e2a-0f3b-4a6c-9e57-1d2b3c4a5f60",
  "name": "Urban Gardening"
}

`Community`

Eine Community dieser Instanz.

Feld	Typ	Bedeutung
`id`	`string`	Die ID der Community.
`name`	`string`	Ihr Name.
`description`	`string`oder null	Die Beschreibung (`null`, wenn es keine gibt).
`tags`	`string[]`	Die Themen, um die es geht.
`members`	`integer`	Wie viele Mitglieder sie hat.
`joinPolicy`	`string`	Wie man hineinkommt. `open` — Jede und jeder kann beitreten. `application` — Beitreten braucht eine Bewerbung, die die Community annimmt. `invite` — Nur auf Einladung.
`visibility`	`string`	Wer sie sehen kann. Über einen Schlüssel immer `open`. Die anderen sind nicht erreichbar. `open` — Für alle sichtbar.

Beispiel

{
  "id": "c81d4e2a-0f3b-4a6c-9e57-1d2b3c4a5f60",
  "name": "Urban Gardening",
  "description": "Balconies, allotments, rooftops: whatever grows.",
  "tags": [
    "garden",
    "bees"
  ],
  "members": 312,
  "joinPolicy": "open",
  "visibility": "open"
}

`Tag`

Ein Tag und wie viele Beiträge ihn tragen.

Feld	Typ	Bedeutung
`tag`	`string`	Der Tag, ohne `#`.
`posts`	`integer`	Wie viele neuere Beiträge ihn tragen.

Beispiel

{
  "tag": "garden",
  "posts": 58
}

`SearchResult`

Was eine Suche findet: drei Listen, jede womöglich leer, nie fehlend.

Feld	Typ	Bedeutung
`posts`	`Post[]`	Passende Beiträge, neueste zuerst.
`profiles`	`ProfileBrief[]`	Passende Profile, nach Kurzname.
`tags`	`Tag[]`	Passende Tags, meistbenutzte zuerst.

Beispiel

{
  "posts": [
    {
      "id": "5f0c2a9e-8d41-4b7a-9c3e-2e61d0f4a7b1",
      "text": "The bees are back in the garden 🐝 #garden",
      "kind": "poll",
      "author": {
        "id": "a3e1f7c2-54b9-4d0e-8f16-7b2c9d4e1a05",
        "handle": "mara",
        "name": "Mara 🌻",
        "verified": true,
        "accountKind": "person"
      },
      "community": {
        "id": "c81d4e2a-0f3b-4a6c-9e57-1d2b3c4a5f60",
        "name": "Urban Gardening"
      },
      "media": [
        {
          "url": "/api/media?id=b2d7e9f1-3c4a-4e8b-a1f0-6d5c4b3a2918"
        }
      ],
      "poll": {
        "options": [
          {
            "text": "Lavender",
            "votes": 12
          },
          {
            "text": "Sunflowers",
            "votes": 7
          },
          {
            "text": "Clover",
            "votes": 3
          }
        ],
        "total": 22,
        "multiple": false,
        "endsAt": 1758710400000,
        "running": true,
        "resultsVisible": true,
        "myVotes": [
          0
        ]
      },
      "quotes": null,
      "continues": null,
      "counts": {
        "replies": 4,
        "likes": 31,
        "reposts": 2
      },
      "pinned": false,
      "createdAt": 1758624000000
    }
  ],
  "profiles": [
    {
      "id": "a3e1f7c2-54b9-4d0e-8f16-7b2c9d4e1a05",
      "handle": "mara",
      "name": "Mara 🌻",
      "verified": true,
      "accountKind": "person"
    }
  ],
  "tags": [
    {
      "tag": "garden",
      "posts": 58
    }
  ]
}

`Emoji`

Ein Emoji dieser Instanz.

Feld	Typ	Bedeutung
`name`	`string`	Der Name, wie er zwischen den Doppelpunkten steht.
`url`	`string`	Die Adresse des Bildes, relativ zu dieser Instanz.

Beispiel

{
  "name": "tellmelo",
  "url": "/api/media?id=e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}

`Notification`

Eine Mitteilung. Eine Zeile kann mehrere Ereignisse derselben Art sammeln.

Feld	Typ	Bedeutung
`id`	`string`	Die ID der Mitteilung.
`kind`	`string`	Was passiert ist. `reply` — Jemand hat dir geantwortet. `like` — Jemandem gefällt dein Beitrag. `repost` — Jemand hat deinen Beitrag geteilt. `follow` — Jemand folgt dir. `mention` — Jemand hat dich erwähnt. `group_mention` — Jemand hat eine Gruppe erwähnt, die du leitest; `text` ist ihr Name. `message` — Jemand hat dir eine Nachricht geschrieben. `scheduled` — Ein geplanter Beitrag von dir ist erschienen. `reminder` — Eine Erinnerung an einen gespeicherten Beitrag ist fällig. `report` — Was aus einer Meldung geworden ist, die du geschickt hast. `moderation` — Eine Entscheidung über dein Konto: eine Verwarnung, eine Einschränkung, ein Einspruch. `team` — Neue Arbeit fürs Team, nur für Inhaber, Admins und Moderatoren: Meldungen, Widersprüche, eingereichte Links, Anliegen, Anträge auf Verifizierung und Kündigungen.
`text`	`string`oder null	Nur bei Meldungen und Moderation: der Text, der dazugehört. Sonst `null`. Den Satz zu einer Mitteilung baut dein Programm.
`actor`	`Actor`	Wer es getan hat.
`postId`	`string`oder null	Der Beitrag, um den es geht (`null`, wenn es um keinen geht).
`read`	`boolean`	Ob sie als gelesen markiert ist.
`more`	`integer`	Für wie viele weitere Ereignisse diese Zeile steht, über das genannte hinaus.
`createdAt`	`integer`	Wann es zum ersten Mal passiert ist.
`updatedAt`	`integer`	Wann sie zuletzt ein weiteres Ereignis gesammelt hat. Danach ist die Liste sortiert.

Beispiel

{
  "id": "3f2e1d0c-9b8a-4765-8432-10fedcba9876",
  "kind": "like",
  "text": null,
  "actor": {
    "handle": "jon",
    "name": "Jon"
  },
  "postId": "5f0c2a9e-8d41-4b7a-9c3e-2e61d0f4a7b1",
  "read": false,
  "more": 2,
  "createdAt": 1758624300000,
  "updatedAt": 1758624900000
}

`Actor`

Wer eine Mitteilung ausgelöst hat.

Feld	Typ	Bedeutung
`handle`	`string`	Der Kurzname.
`name`	`string`	Der Anzeigename.

Beispiel

{
  "handle": "jon",
  "name": "Jon"
}

`Conversation`

Eine Zeile deines Postfachs.

Feld	Typ	Bedeutung
`with`	`string`	Die ID des anderen Kontos: das, was `/conversations/{with}/messages` erwartet.
`handle`	`string`	Sein Kurzname.
`name`	`string`	Sein Anzeigename.
`excerpt`	`string`oder null	Der Anfang der letzten Nachricht (`null`, wenn sie keinen Text hat).
`truncated`	`boolean`	Ob der Anfang gekürzt wurde.
`fromMe`	`boolean`	Ob die letzte Nachricht von dir ist.
`lastMessageId`	`string`	Die ID der letzten Nachricht.
`unread`	`integer`	Wie viele seiner Nachrichten du noch nicht gelesen hast.
`updatedAt`	`integer`	Wann die letzte Nachricht geschrieben wurde.

Beispiel

{
  "with": "d4c3b2a1-6e5f-4a7b-9c8d-1e2f3a4b5c6d",
  "handle": "jon",
  "name": "Jon",
  "excerpt": "See you on Saturday at the market!",
  "truncated": false,
  "fromMe": true,
  "lastMessageId": "7c6b5a49-3827-4165-9f0e-d1c2b3a49586",
  "unread": 0,
  "updatedAt": 1758624060000
}

`Message`

Eine Nachricht in einer Unterhaltung.

Feld	Typ	Bedeutung
`id`	`string`	Die ID der Nachricht.
`text`	`string`oder null	Der Text (`null` bei einer Nachricht, die nur aus Bildern besteht).
`from`	`string`	Die ID des Kontos, das sie geschrieben hat.
`to`	`string`	Die ID des Kontos, an das sie ging.
`read`	`boolean`	Ob die Empfängerin oder der Empfänger sie gelesen hat.
`media`	`Media[]`	Ihre Bilder; leer, wenn es keine gibt.
`replyTo`	`string`oder null	Die `id` der Nachricht, auf die diese antwortet (`null`, wenn sie auf keine antwortet). Seit 2.2.
`createdAt`	`integer`	Wann sie gesendet wurde.

Beispiel

{
  "id": "7c6b5a49-3827-4165-9f0e-d1c2b3a49586",
  "text": "See you on Saturday at the market!",
  "from": "a3e1f7c2-54b9-4d0e-8f16-7b2c9d4e1a05",
  "to": "d4c3b2a1-6e5f-4a7b-9c8d-1e2f3a4b5c6d",
  "read": true,
  "media": [],
  "replyTo": null,
  "createdAt": 1758624060000
}

`Created`

Die Antwort eines Schreibzugriffs, der etwas angelegt hat.

Feld	Typ	Bedeutung
`id`	`string`	Die ID dessen, was angelegt wurde.
`scheduledFor`	`integer`oder null	Wann es erscheint, wenn die Veröffentlichung geplant wurde (sonst `null`).
`deleteAt`	`integer`oder null	Wann es sich selbst löscht, wenn das eingestellt wurde (sonst `null`).

Beispiel

{
  "id": "5f0c2a9e-8d41-4b7a-9c3e-2e61d0f4a7b1",
  "scheduledFor": null,
  "deleteAt": null
}

`Ok`

Die Antwort eines Schreibzugriffs, der nichts zurückzugeben hat.

Feld	Typ	Bedeutung
`ok`	`boolean`	Immer `true`.

Beispiel

{
  "ok": true
}

Die maschinenlesbare Beschreibung

Dieselbe Tabelle, aus der diese Seite gebaut ist, liegt unter /api/v2/openapi.json: Wege, Parameter, Rechte und die Gestalten, die zurückkommen. Ein Erzeuger für Clients kann sie lesen, und sie kann nicht von der API abdriften, denn die Seite, der Verteiler und die Beschreibung kommen aus einer Liste.

https://tellmelo.com/api/v2/openapi.json

Was aus v1 geworden ist

v1 ist entfernt. Die alten Wege unter /api/v1/ antworten 410 und sagen im Rumpf, wohin es weitergeht. Keine Weiterleitung, denn v2 antwortet in einer anderen Gestalt, und ein Programm, das ihr folgte, bekäme ein 200, das es nicht lesen kann. Es gab zu diesem Zeitpunkt noch keine öffentlichen Konten und damit niemanden mit einem Programm darauf; später zu entfernen hätte geheissen, es nie zu tun.

Was wir erwarten

Dieselben Grundsätze wie überall sonst: keine Belästigung, kein Spam, keine fremden Inhalte ohne Recht daran. Ein Programm entschuldigt nichts. Für das, was dein Schlüssel schreibt, stehst du gerade.

API

Überblick

Schnellstart

Dein Schlüssel

Was ein Schlüssel darf

Was kein Schlüssel kann

Anfragen und Antworten

Seiten

Nur das Neue

Grenzen

Header

Was du schickst

Was zurückkommt

Wenn etwas nicht geht

Versionen

Endpunkte

Der Einstieg

GET/api/v2

Beispielanfrage

Antwort

Beiträge

GET/api/v2/posts

Parameter

Beispielanfrage

Antwort

GET/api/v2/posts/{id}

Parameter

Beispielanfrage

Antwort

POST/api/v2/posts

Parameter

Beispielanfrage

Antwort

DELETE/api/v2/posts/{id}

Parameter

Beispielanfrage

Antwort

Antworten

GET/api/v2/posts/{id}/replies

Parameter

Beispielanfrage

Antwort

POST/api/v2/posts/{id}/replies

Parameter

Beispielanfrage

Antwort

Umfragen

POST/api/v2/posts/{id}/vote

Parameter

Beispielanfrage

Antwort

Profile

GET/api/v2/profiles/{handle}

Parameter

Beispielanfrage

Antwort

GET/api/v2/profiles/{handle}/posts

Parameter

Beispielanfrage

Antwort

Communities

GET/api/v2/communities

Parameter

Beispielanfrage

Antwort

GET/api/v2/communities/{id}

Parameter

Beispielanfrage

Antwort

GET/api/v2/communities/{id}/posts

Parameter

Beispielanfrage

Antwort

Entdecken

GET/api/v2/tags

Parameter

Beispielanfrage

Antwort

GET/api/v2/search

Parameter

GET`/api/v2`

GET`/api/v2/posts`

GET`/api/v2/posts/{id}`

POST`/api/v2/posts`

DELETE`/api/v2/posts/{id}`

GET`/api/v2/posts/{id}/replies`

POST`/api/v2/posts/{id}/replies`

POST`/api/v2/posts/{id}/vote`

GET`/api/v2/profiles/{handle}`

GET`/api/v2/profiles/{handle}/posts`

GET`/api/v2/communities`

GET`/api/v2/communities/{id}`

GET`/api/v2/communities/{id}/posts`

GET`/api/v2/tags`

GET`/api/v2/search`

GET`/api/v2/emojis`

GET`/api/v2/me`

GET`/api/v2/feed`

GET`/api/v2/notifications`

POST`/api/v2/notifications/read`

GET`/api/v2/conversations`

GET`/api/v2/conversations/{with}/messages`

POST`/api/v2/conversations/{with}/messages`

POST`/api/v2/conversations/{with}/read`

POST`/api/v2/relations`

`Service`

`RateLimit`

`Post`

`Reply`

`Counts`

`Media`

`Poll`

`PollOption`

`ProfileBrief`

`Profile`

`CommunityBrief`

`Community`

`Tag`

`SearchResult`

`Emoji`

`Notification`

`Actor`

`Conversation`

`Message`

`Created`

`Ok`