API reference

Ibinabalik ang profile ng authenticated na user.

Ina-update ang mga profile field tulad ng display name at notification preference.

Sina-synchronize ang Supabase auth user sa platform user record.

Inirereport kung nakumpleto na ng authenticated na user ang onboarding.

Nag-a-upload ng bagong avatar image para sa authenticated na user.

Naglilista ng mga robot na naka-register ng authenticated na kliyente, pinakabago muna, hanggang 50 entry. ISO 8601 ang mga timestamp; null ang last_online at last_heartbeat hangga't hindi pa nagkakaroon ng koneksyon ang robot.

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

Nagre-register ng bagong robot at ibinabalik ang id nito. Isang robot lang ang puwedeng pagmayarian ng isang motor board hardware id; tinatanggihan ang collision gamit ang status 409.

Ibinabalik ang client profile ng authenticated na user.

Ina-update ang mga field ng client profile.

Naglilista ng mga cloud dataset ng kliyente kasama ang bilang ng episode at sukat.

Naglilista ng mga buwanang invoice ng kliyente.

Ibinabalik ang usage statistics para sa client dashboard.

Ibinabalik ang operator profile ng authenticated na user.

Gumagawa o nag-a-update ng operator profile.

Naglilista ng mga robot na available ngayon at tugma sa mga certification ng operator.

Naglilista ng mga certification request ng operator at ang status nila.

Humihiling ng certification para sa isang robot type.

Ibinabalik ang lingguhang availability schedule ng operator.

Ina-update ang lingguhang availability schedule.

Ibinabalik ang kasalukuyang availability ng operator.

Ibinabalik ang earnings at session statistics para sa operator dashboard.

Naglilista ng mga session para sa authenticated na user. Nakikita ng mga operator ang mga session na pinatakbo nila; nakikita ng mga kliyente ang mga session sa robot nila. Bahagyang naiiba ang field set sa pagitan ng dalawang view: kasama sa client view ang episodes_collected at data_collected_mb, kasama sa operator view ang 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."
    }
  ]
}

Nagsisimula ng teleoperation session sa isang available na robot. Kailangan ang operator role: hindi puwedeng magsimula ng session ang mga kliyente. Isang ACTIVE o PAUSED na session lang ang puwedeng hawakan ng operator nang sabay, at dapat AVAILABLE ang status ng robot sa oras na iyon. Sa isang immediate na start, lumilipat ang robot sa IN_SESSION at ina-notify ang kliyente.

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

Ibinabalik ang isang session kasama ang mga detalye nito.

Ina-update ang session lifecycle: pause, resume, end, at kaugnay na aksyon.

Humihiling ng extension ng session. Ang kliyenteng may-ari ng session lang ang puwedeng tumawag dito, at dapat ACTIVE ang session. Nila-log ang request bilang session event at nakakatanggap ng notification ang operator; ang extension mismo ay nangyayari kapag kumilos ang operator dito.

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

Naglilista ng mga chat message ng isang session.

Nagpapadala ng chat message sa isang session.

Nire-rate ang isang natapos na session sa 1 hanggang 5 star scale, may opsyonal na comment.

Nag-e-export ng session data.

Gumagawa o ibinabalik ang Stripe customer na ginagamit para sa client billing.

Ibinabalik ang status ng Stripe Connect account ng operator.

Sinisimulan ang Stripe Connect onboarding para sa operator payout.

Gumagawa ng Stripe SetupIntent para sa pag-save ng payment method.

Gumagawa ng Stripe billing portal session para sa pamamahala ng payment method at invoice.

Ibinabalik ang impormasyon ng payout para sa authenticated na operator.

Humihiling ng payout ng naipong earnings. Ang minimum na payout ay 10.00 EUR.

Tumatanggap ng Stripe webhook event. Tinatawag ng Stripe, hindi ng API client.

Health check para sa API at koneksyon nito sa database. Nagbabalik ng 200 kapag maayos ang dalawa; kung nabigo ang database check, ibinabalik ang parehong shape na may status at db na naka-set sa error at HTTP status 503.

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

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

Ibinabalik ang pampublikong impormasyon tungkol sa isang suportadong robot model.

Ibinabalik ang kasalukuyang pampublikong pricing plan.

Nag-su-submit ng mensahe sa contact form. Nakaimbak muna ang mensahe bago ihatid sa pamamagitan ng email, kaya hindi ito nawawala kahit may pansamantalang outage sa mail: sa ganitong sitwasyon, iniuulat ng response na stored true at delivered false, at ine-retry ang delivery sa operational na antas.

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
}

Humihiling ng support para sa robot type na wala pa sa platform.

Ibinabalik ang pampublikong statistics ng platform.