API reference

Mengembalikan profil pengguna yang disahkan.

Mengemas kini medan profil seperti nama paparan dan keutamaan pemberitahuan.

Menyelaraskan pengguna auth Supabase dengan rekod pengguna platform.

Melaporkan sama ada pengguna yang disahkan telah melengkapkan onboarding.

Memuat naik imej avatar baharu untuk pengguna yang disahkan.

Menyenaraikan robot yang didaftarkan oleh pelanggan yang disahkan, terbaharu dahulu, sehingga 50 rekod. Cap masa adalah ISO 8601; last_online dan last_heartbeat adalah null sehingga robot pernah menyambung 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 baharu dan mengembalikan id-nya. hardware id papan motor hanya boleh tergolong kepada satu robot; pertembungan ditolak dengan status 409.

Mengembalikan profil pelanggan pengguna yang disahkan.

Mengemas kini medan profil pelanggan.

Menyenaraikan set data awan pelanggan dengan bilangan episod dan saiz.

Menyenaraikan invois bulanan pelanggan.

Mengembalikan statistik penggunaan untuk papan pemuka pelanggan.

Mengembalikan profil operator pengguna yang disahkan.

Mencipta atau mengemas kini profil operator.

Menyenaraikan robot yang tersedia pada masa ini dan sepadan dengan sijil operator.

Menyenaraikan permintaan sijil operator dan statusnya.

Meminta sijil untuk satu jenis robot.

Mengembalikan jadual ketersediaan mingguan operator.

Mengemas kini jadual ketersediaan mingguan.

Mengembalikan ketersediaan semasa operator.

Mengembalikan statistik pendapatan dan sesi untuk papan pemuka operator.

Menyenaraikan sesi untuk pengguna yang disahkan. Operator melihat sesi yang mereka kendalikan; pelanggan melihat sesi pada robot mereka. Set medan berbeza sedikit antara kedua-dua paparan: paparan pelanggan merangkumi episodes_collected dan data_collected_mb, paparan operator merangkumi 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."
    }
  ]
}

Memulakan sesi teleoperasi pada robot yang tersedia. Memerlukan peranan operator: pelanggan tidak boleh memulakan sesi. Seorang operator boleh memegang paling banyak satu sesi ACTIVE atau PAUSED pada satu masa, dan robot itu mesti pada masa ini berstatus AVAILABLE. Pada permulaan segera robot bertukar kepada IN_SESSION dan pelanggan dimaklumkan.

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 tunggal berserta perinciannya.

Mengemas kini kitaran hayat sesi: jeda, sambung semula, tamat, dan tindakan berkaitan.

Meminta lanjutan sesi. Hanya pelanggan yang memiliki sesi boleh memanggil ini, dan sesi itu mesti ACTIVE. Permintaan direkodkan sebagai peristiwa sesi dan operator menerima pemberitahuan; lanjutan itu sendiri berlaku apabila operator bertindak ke atasnya.

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

Menyenaraikan mesej sembang bagi satu sesi.

Menghantar mesej sembang dalam satu sesi.

Menilai sesi yang selesai pada skala 1 hingga 5 bintang, dengan komen pilihan.

Mengeksport data sesi.

Mencipta atau mengembalikan pelanggan Stripe yang digunakan untuk pengebilan pelanggan.

Mengembalikan status akaun Stripe Connect operator.

Memulakan onboarding Stripe Connect untuk pengeluaran operator.

Mencipta Stripe SetupIntent untuk menyimpan kaedah pembayaran.

Mencipta sesi portal pengebilan Stripe untuk menguruskan kaedah pembayaran dan invois.

Mengembalikan maklumat pengeluaran untuk operator yang disahkan.

Meminta pengeluaran pendapatan yang terkumpul. Pengeluaran minimum ialah 10.00 EUR.

Menerima peristiwa webhook daripada Stripe. Dipanggil oleh Stripe, bukan oleh klien API.

Semakan kesihatan untuk API dan sambungan pangkalan datanya. Mengembalikan 200 apabila kedua-duanya baik; jika semakan pangkalan data gagal, bentuk yang sama dikembalikan dengan status dan db ditetapkan kepada 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 maklumat awam mengenai model robot yang disokong.

Mengembalikan pelan harga awam semasa.

Menghantar mesej borang hubungi. Mesej itu disimpan dahulu dan kemudian dihantar melalui e-mel, jadi gangguan mel sementara tidak akan kehilangannya: dalam kes itu respons melaporkan stored true dan delivered false, dan penghantaran dicuba semula secara operasi.

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 sokongan untuk jenis robot yang belum ada pada platform.

Mengembalikan statistik platform awam.