API-Referenz

Liefert das Profil des authentifizierten Nutzers.

Aktualisiert Profilfelder wie den Anzeigenamen und die Benachrichtigungseinstellungen.

Synchronisiert den Supabase-Auth-Nutzer mit dem Plattform-Nutzerdatensatz.

Meldet, ob der authentifizierte Nutzer das Onboarding abgeschlossen hat.

Lädt ein neues Avatar-Bild für den authentifizierten Nutzer hoch.

Listet die vom authentifizierten Kunden registrierten Roboter, neueste zuerst, bis zu 50 Einträge. Zeitstempel sind ISO 8601; last_online und last_heartbeat sind null, bis sich der Roboter einmal verbunden hat.

curl https://www.ay-robots.com/api/client/robots \
  -H 'Authorization: Bearer ayr_live_your_key_here'

[
  {
    "id": "1f9f4c1e-7f2a-4b7e-9a45-0f4d2b6c8a11",
    "name": "Lab SO-100",
    "robot_type": "SO-100",
    "status": "AVAILABLE",
    "control_url": "wss://robots.example.com/so100/control",
    "stream_url": "https://robots.example.com/so100/stream",
    "hardware_id": "board:local:usb-1",
    "last_online": "2026-08-09T10:12:00.000Z",
    "last_heartbeat": "2026-08-09T10:12:00.000Z",
    "total_hours": 12.5,
    "tags": ["lab"],
    "notes": null,
    "created_at": "2026-07-01T09:00:00.000Z"
  }
]

Registriert einen neuen Roboter und liefert seine Id. Eine Motor-Board-Hardware-Id kann nur zu einem Roboter gehören; eine Kollision wird mit Status 409 abgelehnt.

Liefert das Kundenprofil des authentifizierten Nutzers.

Aktualisiert Felder des Kundenprofils.

Listet die Cloud-Datensätze des Kunden mit Episodenzahlen und Größen.

Listet die Monatsrechnungen des Kunden.

Liefert Nutzungsstatistiken für das Kunden-Dashboard.

Liefert das Operator-Profil des authentifizierten Nutzers.

Legt das Operator-Profil an oder aktualisiert es.

Listet Roboter, die aktuell verfügbar sind und zu den Zertifizierungen des Operators passen.

Listet die Zertifizierungsanträge des Operators und deren Status.

Beantragt die Zertifizierung für einen Robotertyp.

Liefert den wöchentlichen Verfügbarkeitsplan des Operators.

Aktualisiert den wöchentlichen Verfügbarkeitsplan.

Liefert die aktuelle Verfügbarkeit des Operators.

Liefert Verdienst- und Session-Statistiken für das Operator-Dashboard.

Listet Sessions für den authentifizierten Nutzer. Operatoren sehen Sessions, die sie gefahren haben; Kunden sehen Sessions auf ihren Robotern. Die Feldmenge unterscheidet sich leicht zwischen beiden Sichten: Die Kundensicht enthält episodes_collected und data_collected_mb, die Operator-Sicht operator_earnings_cents.

curl 'https://www.ay-robots.com/api/sessions?status=COMPLETED&limit=10' \
  -H 'Authorization: Bearer ayr_live_your_key_here'

{
  "sessions": [
    {
      "id": "6b0d2c9a-53f1-4f6e-8f1a-2c9d4e7b5a30",
      "status": "COMPLETED",
      "started_at": "2026-08-08T14:00:12.000Z",
      "ended_at": "2026-08-08T14:47:31.000Z",
      "duration_minutes": 47,
      "client_charge_cents": 1175,
      "episodes_collected": 23,
      "data_collected_mb": 210.4,
      "rating": 5,
      "created_at": "2026-08-08T13:59:58.000Z",
      "robot_id": "1f9f4c1e-7f2a-4b7e-9a45-0f4d2b6c8a11",
      "robot_name": "Lab SO-100",
      "robot_type": "SO-100",
      "operator_name": "Jane D."
    }
  ]
}

Startet eine Teleoperations-Session auf einem verfügbaren Roboter. Verlangt die Operator-Rolle: Kunden können keine Sessions starten. Ein Operator kann höchstens eine ACTIVE- oder PAUSED-Session gleichzeitig halten, und der Roboter muss aktuell den Status AVAILABLE haben. Bei sofortigem Start wechselt der Roboter auf IN_SESSION und der Kunde wird benachrichtigt.

curl -X POST https://www.ay-robots.com/api/sessions \
  -H 'Authorization: Bearer ayr_live_your_key_here' \
  -H 'Content-Type: application/json' \
  -d '{"robotId": "1f9f4c1e-7f2a-4b7e-9a45-0f4d2b6c8a11"}'

{
  "sessionId": "6b0d2c9a-53f1-4f6e-8f1a-2c9d4e7b5a30",
  "status": "ACTIVE"
}

Liefert eine einzelne Session mit ihren Details.

Aktualisiert den Session-Lebenszyklus: pausieren, fortsetzen, beenden und verwandte Aktionen.

Fordert eine Session-Verlängerung an. Nur der Kunde, dem die Session gehört, kann diesen Endpunkt aufrufen, und die Session muss ACTIVE sein. Die Anfrage wird als Session-Ereignis protokolliert und der Operator erhält eine Benachrichtigung; die Verlängerung selbst geschieht, wenn der Operator darauf reagiert.

curl -X POST https://www.ay-robots.com/api/sessions/6b0d2c9a-53f1-4f6e-8f1a-2c9d4e7b5a30/extend \
  -H 'Authorization: Bearer ayr_live_your_key_here' \
  -H 'Content-Type: application/json' \
  -d '{"additionalMinutes": 30}'

{
  "message": "Extension request sent to operator"
}

Listet die Chat-Nachrichten einer Session.

Sendet eine Chat-Nachricht in einer Session.

Bewertet eine abgeschlossene Session auf einer Skala von 1 bis 5 Sternen, mit optionalem Kommentar.

Exportiert Session-Daten.

Legt den Stripe-Kunden für die Kundenabrechnung an oder liefert ihn zurück.

Liefert den Status des Stripe-Connect-Kontos des Operators.

Startet das Stripe-Connect-Onboarding für Operator-Auszahlungen.

Erzeugt einen Stripe-SetupIntent zum Hinterlegen einer Zahlungsmethode.

Erzeugt eine Stripe-Abrechnungsportal-Session zum Verwalten von Zahlungsmethoden und Rechnungen.

Liefert Auszahlungsinformationen für den authentifizierten Operator.

Fordert eine Auszahlung des angesammelten Guthabens an. Die Mindestauszahlung beträgt 10,00 EUR.

Empfängt Stripe-Webhook-Ereignisse. Wird von Stripe aufgerufen, nicht von API-Clients.

Health-Check für die API und ihre Datenbankverbindung. Liefert 200, wenn beide in Ordnung sind; scheitert die Datenbankprüfung, kommt dieselbe Struktur mit status und db auf error und HTTP-Status 503 zurück.

curl https://www.ay-robots.com/api/health

{
  "status": "ok",
  "db": "ok",
  "timestamp": "2026-08-09T10:12:00.000Z"
}

Liefert öffentliche Informationen über ein unterstütztes Robotermodell.

Liefert die aktuellen öffentlichen Preispläne.

Übermittelt eine Kontaktformular-Nachricht. Die Nachricht wird erst gespeichert und dann per E-Mail zugestellt; ein vorübergehender Mail-Ausfall verliert sie also nicht: In dem Fall meldet die Antwort stored true und delivered false, und die Zustellung wird operativ erneut versucht.

curl -X POST https://www.ay-robots.com/api/contact \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Jane Doe",
    "email": "jane@example.com",
    "category": "Technical Support",
    "subject": "SO-100 pairing question",
    "message": "My arm shows as offline after pairing."
  }'

{
  "success": true,
  "message": "Message sent successfully",
  "id": "b1f2c3d4-0000-0000-0000-000000000000",
  "stored": true,
  "delivered": true
}

Fragt Unterstützung für einen Robotertyp an, den die Plattform noch nicht kennt.

Liefert öffentliche Plattform-Statistiken.