Referensi API

Mengembalikan profil pengguna yang terautentikasi.

Memperbarui field profil seperti nama tampilan dan preferensi notifikasi.

Menyinkronkan pengguna auth Supabase dengan catatan pengguna platform.

Melaporkan apakah pengguna yang terautentikasi telah menyelesaikan onboarding.

Mengunggah gambar avatar baru untuk pengguna yang terautentikasi.

Mencantumkan robot yang didaftarkan oleh client yang terautentikasi, terbaru lebih dulu, hingga 50 entri. Stempel waktu adalah ISO 8601; last_online dan last_heartbeat bernilai null sampai robot pernah terhubung sekali.

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"
  }
]

Mendaftarkan robot baru dan mengembalikan id-nya. Hardware id sebuah motor board hanya boleh dimiliki satu robot; tabrakan ditolak dengan status 409.

Mengembalikan profil client dari pengguna yang terautentikasi.

Memperbarui field profil client.

Mencantumkan dataset cloud milik client dengan jumlah episode dan ukurannya.

Mencantumkan invoice bulanan milik client.

Mengembalikan statistik penggunaan untuk dashboard client.

Mengembalikan profil operator dari pengguna yang terautentikasi.

Membuat atau memperbarui profil operator.

Mencantumkan robot yang saat ini tersedia dan cocok dengan sertifikasi operator.

Mencantumkan permintaan sertifikasi operator dan statusnya.

Meminta sertifikasi untuk sebuah jenis robot.

Mengembalikan jadwal ketersediaan mingguan operator.

Memperbarui jadwal ketersediaan mingguan.

Mengembalikan ketersediaan operator saat ini.

Mengembalikan statistik penghasilan dan sesi untuk dashboard operator.

Mencantumkan sesi untuk pengguna yang terautentikasi. Operator melihat sesi yang mereka operasikan; client melihat sesi pada robot mereka. Kumpulan field-nya sedikit berbeda antara kedua tampilan: tampilan client menyertakan episodes_collected dan data_collected_mb, tampilan operator menyertakan 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."
    }
  ]
}

Memulai sesi teleoperasi pada robot yang tersedia. Membutuhkan peran operator: client tidak bisa memulai sesi. Seorang operator bisa memegang paling banyak satu sesi ACTIVE atau PAUSED sekaligus, dan robotnya harus saat ini berstatus AVAILABLE. Pada mulai langsung, robot berpindah ke IN_SESSION dan client diberi notifikasi.

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"
}

Mengembalikan satu sesi beserta detailnya.

Memperbarui siklus hidup sesi: jeda, lanjutkan, akhiri, dan aksi terkait lainnya.

Meminta perpanjangan sesi. Hanya client pemilik sesi yang bisa memanggil ini, dan sesinya harus ACTIVE. Permintaan dicatat sebagai session event dan operator menerima notifikasi; perpanjangannya sendiri terjadi saat operator menindaklanjutinya.

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"
}

Mencantumkan pesan chat sebuah sesi.

Mengirim pesan chat dalam sebuah sesi.

Memberi rating pada sesi yang selesai dalam skala 1 sampai 5 bintang, dengan komentar opsional.

Mengekspor data sesi.

Membuat atau mengembalikan Stripe customer yang dipakai untuk penagihan client.

Mengembalikan status akun Stripe Connect milik operator.

Memulai onboarding Stripe Connect untuk pembayaran operator.

Membuat Stripe SetupIntent untuk menyimpan metode pembayaran.

Membuat sesi Stripe billing portal untuk mengelola metode pembayaran dan invoice.

Mengembalikan informasi pembayaran untuk operator yang terautentikasi.

Meminta pembayaran atas penghasilan yang terkumpul. Pembayaran minimum adalah 10.00 EUR.

Menerima event webhook Stripe. Dipanggil oleh Stripe, bukan oleh client API.

Pemeriksaan kesehatan untuk API dan koneksi database-nya. Mengembalikan 200 saat keduanya baik-baik saja; jika pemeriksaan database gagal, bentuk yang sama dikembalikan dengan status dan db diset ke error dan status HTTP 503.

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

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

Mengembalikan informasi publik tentang sebuah model robot yang didukung.

Mengembalikan paket harga publik saat ini.

Mengirim pesan formulir kontak. Pesan disimpan lebih dulu lalu dikirim lewat email, jadi gangguan sementara pada layanan mail tidak menghilangkannya: dalam kasus itu respons melaporkan stored true dan delivered false, dan pengiriman dicoba ulang secara operasional.

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
}

Meminta dukungan untuk sebuah jenis robot yang belum ada di platform.

Mengembalikan statistik publik platform.