Zum Inhalt springen

REST API

Alles, was die weside App und CLI machen, machen sie über dieselbe HTTP-API. Wenn du ein Script, einen Webhook-Handler oder dein eigenes Tool brauchst, um den Companion-Status zu lesen oder zu verändern, sprichst du direkt mit dieser API.

Eine JSON REST API von weside-core. Jede Route lebt unter einem einzigen Version-Präfix:

https://api.weside.ai/api/v1

Die Oberfläche spiegelt das Produkt: /auth, /users, /companions, /chat, /circles, /channels, /data-residency, /notes, /voice und mehr (Memory-Routes sind unter /companions/{companion_id}/memories verschachtelt). Für die vollständige, immer aktuelle Liste hol dir das OpenAPI-Schema unter /openapi.json.

Der MCP server und die CLI decken die gängigen Fälle ab — einen Companion adoptieren, Erinnerungen lesen, Ziele nachverfolgen. Die REST API ist die Schicht darunter: nutze sie, wenn du etwas brauchst, das sie nicht freilegen, oder wenn du weside in ein System integrierst, das bereits HTTP spricht.

Authentifiziere dich mit einem Bearer Token — dem Supabase Access Token aus einer angemeldeten weside-Session — bei jeder Anfrage:

Terminal window
curl https://api.weside.ai/api/v1/auth/me \
-H "Authorization: Bearer $SUPABASE_ACCESS_TOKEN"

GET /api/v1/auth/me gibt den aktuellen User zurück — eine schnelle Möglichkeit, um zu bestätigen, dass dein Token funktioniert.

Liste die Companions auf deinem Account auf:

Terminal window
curl https://api.weside.ai/api/v1/companions \
-H "Authorization: Bearer $SUPABASE_ACCESS_TOKEN"

Die Response enthält die Companion IDs, die du dann gegen Companion-spezifische Routes nutzt (Chat, Memory, Skills). Jeder Endpoint gibt JSON zurück; Fehler folgen RFC 9457 Problem-Details, also hat ein Fehler-Body ein maschinenlesbares type und detail, bei dem du branchen kannst.

  • Auth ist das Supabase JWT, nicht ein statischer API Key. Tokens verfallen — erneuer sie über die Supabase-Session, denselben Flow, den auch die App nutzt. (Um deinen Companion stattdessen als LLM-Backend zu laufen, siehe Verbinde deinen eigenen Modell-Key.)
  • Rate Limits gelten pro Route; Read- und Write-Endpoints haben separate Budgets. Ein 429 bedeutet, dass du backoff machen solltest.
  • Row-level Security wird Server-seitig durchgesetzt. Du siehst nur deine eigenen Daten — ein Token kann nicht auf einen anderen User’s Companion zugreifen.
  • Behandle /openapi.json als die Quelle der Wahrheit. Routes werden kontinuierlich ausgeliefert; diese Seite dokumentiert die Form, nicht eine erschöpfende Liste.