เอกสารอ้างอิง API

ส่งคืนโปรไฟล์ของผู้ใช้ที่ยืนยันตัวตนแล้ว

อัปเดตฟิลด์โปรไฟล์ เช่น ชื่อที่แสดงและการตั้งค่าการแจ้งเตือน

ซิงค์ผู้ใช้ auth ของ Supabase กับระเบียนผู้ใช้ของแพลตฟอร์ม

รายงานว่าผู้ใช้ที่ยืนยันตัวตนแล้วทำ onboarding เสร็จหรือยัง

อัปโหลดรูปภาพ avatar ใหม่สำหรับผู้ใช้ที่ยืนยันตัวตนแล้ว

แสดงรายการหุ่นยนต์ที่ลูกค้าที่ยืนยันตัวตนแล้วลงทะเบียนไว้ ใหม่สุดก่อน สูงสุด 50 รายการ การประทับเวลาเป็น ISO 8601 last_online และ last_heartbeat เป็น null จนกว่าหุ่นยนต์จะเชื่อมต่อครั้งหนึ่ง

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

ลงทะเบียนหุ่นยนต์ใหม่และส่งคืน id ของมัน hardware id ของบอร์ดมอเตอร์หนึ่งตัวสามารถเป็นของหุ่นยนต์ได้เพียงตัวเดียว ความขัดแย้งจะถูกปฏิเสธด้วยสถานะ 409

ส่งคืนโปรไฟล์ลูกค้าของผู้ใช้ที่ยืนยันตัวตนแล้ว

อัปเดตฟิลด์โปรไฟล์ลูกค้า

แสดงรายการชุดข้อมูลคลาวด์ของลูกค้าพร้อมจำนวนเอปิโสดและขนาด

แสดงรายการใบแจ้งหนี้รายเดือนของลูกค้า

ส่งคืนสถิติการใช้งานสำหรับแดชบอร์ดลูกค้า

ส่งคืนโปรไฟล์ผู้ควบคุมของผู้ใช้ที่ยืนยันตัวตนแล้ว

สร้างหรืออัปเดตโปรไฟล์ผู้ควบคุม

แสดงรายการหุ่นยนต์ที่พร้อมใช้งานในขณะนี้และตรงกับการรับรองของผู้ควบคุม

แสดงรายการคำขอการรับรองของผู้ควบคุมและสถานะของแต่ละรายการ

ขอการรับรองสำหรับประเภทหุ่นยนต์หนึ่งประเภท

ส่งคืนตารางความพร้อมใช้งานรายสัปดาห์ของผู้ควบคุม

อัปเดตตารางความพร้อมใช้งานรายสัปดาห์

ส่งคืนความพร้อมใช้งานปัจจุบันของผู้ควบคุม

ส่งคืนสถิติรายได้และเซสชันสำหรับแดชบอร์ดผู้ควบคุม

แสดงรายการเซสชันสำหรับผู้ใช้ที่ยืนยันตัวตนแล้ว ผู้ควบคุมจะเห็นเซสชันที่พวกเขาควบคุม ลูกค้าจะเห็นเซสชันบนหุ่นยนต์ของพวกเขา ชุดฟิลด์แตกต่างกันเล็กน้อยระหว่างสองมุมมอง: มุมมองลูกค้ารวม episodes_collected และ data_collected_mb มุมมองผู้ควบคุมรวม 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."
    }
  ]
}

เริ่มเซสชันควบคุมทางไกลบนหุ่นยนต์ที่พร้อมใช้งาน ต้องการบทบาทผู้ควบคุม ลูกค้าไม่สามารถเริ่มเซสชันได้ ผู้ควบคุมสามารถถือเซสชัน ACTIVE หรือ PAUSED ได้มากที่สุดหนึ่งเซสชันในเวลาเดียวกัน และหุ่นยนต์ต้องมีสถานะ AVAILABLE ในขณะนั้น เมื่อเริ่มทันที หุ่นยนต์จะเปลี่ยนเป็น IN_SESSION และลูกค้าจะได้รับการแจ้งเตือน

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

ส่งคืนเซสชันเดียวพร้อมรายละเอียดของมัน

อัปเดตวงจรชีวิตของเซสชัน: หยุดชั่วคราว ดำเนินการต่อ สิ้นสุด และการกระทำที่เกี่ยวข้อง

ขอขยายเวลาเซสชัน มีเพียงลูกค้าที่เป็นเจ้าของเซสชันเท่านั้นที่เรียกใช้ได้ และเซสชันต้องเป็น ACTIVE คำขอจะถูกบันทึกเป็นเหตุการณ์ของเซสชันและผู้ควบคุมจะได้รับการแจ้งเตือน การขยายเวลาจริงจะเกิดขึ้นเมื่อผู้ควบคุมดำเนินการตอบรับ

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

แสดงรายการข้อความแชทของเซสชันหนึ่ง

ส่งข้อความแชทในเซสชันหนึ่ง

ให้คะแนนเซสชันที่เสร็จสมบูรณ์แล้วในระดับ 1 ถึง 5 ดาว พร้อมความคิดเห็นแบบไม่บังคับ

ส่งออกข้อมูลเซสชัน

สร้างหรือส่งคืนลูกค้า Stripe ที่ใช้สำหรับการเรียกเก็บเงินของลูกค้า

ส่งคืนสถานะบัญชี Stripe Connect ของผู้ควบคุม

เริ่ม onboarding ของ Stripe Connect สำหรับการจ่ายเงินให้ผู้ควบคุม

สร้าง Stripe SetupIntent สำหรับการบันทึกวิธีการชำระเงิน

สร้างเซสชันพอร์ทัลการเรียกเก็บเงินของ Stripe สำหรับจัดการวิธีการชำระเงินและใบแจ้งหนี้

ส่งคืนข้อมูลการจ่ายเงินสำหรับผู้ควบคุมที่ยืนยันตัวตนแล้ว

ขอจ่ายเงินจากรายได้ที่สะสมไว้ การจ่ายเงินขั้นต่ำคือ 10.00 EUR

รับเหตุการณ์ webhook ของ Stripe เรียกโดย Stripe ไม่ใช่โดย API client

การตรวจสอบสุขภาพสำหรับ API และการเชื่อมต่อฐานข้อมูลของมัน ส่งคืน 200 เมื่อทั้งสองอย่างปกติ หากการตรวจสอบฐานข้อมูลล้มเหลว จะส่งคืนโครงสร้างเดียวกันโดย status และ db ถูกตั้งเป็น error และสถานะ HTTP 503

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

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

ส่งคืนข้อมูลสาธารณะเกี่ยวกับรุ่นหุ่นยนต์ที่รองรับรุ่นหนึ่ง

ส่งคืนแผนราคาสาธารณะปัจจุบัน

ส่งข้อความจากแบบฟอร์มติดต่อ ข้อความจะถูกจัดเก็บก่อนแล้วจึงส่งผ่านอีเมล ดังนั้นการหยุดชะงักของเมลชั่วคราวจะไม่ทำให้สูญหาย ในกรณีนั้นการตอบกลับจะรายงาน stored true และ delivered false และการส่งจะถูกลองใหม่ในเชิงปฏิบัติการ

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
}

ขอรองรับประเภทหุ่นยนต์ที่ยังไม่มีบนแพลตฟอร์ม

ส่งคืนสถิติสาธารณะของแพลตฟอร์ม