Tài liệu API

Trả về hồ sơ của người dùng đã xác thực.

Cập nhật các trường hồ sơ như tên hiển thị và tùy chọn thông báo.

Đồng bộ người dùng xác thực Supabase với bản ghi người dùng của nền tảng.

Báo cáo liệu người dùng đã xác thực đã hoàn thành onboarding hay chưa.

Tải lên một hình ảnh avatar mới cho người dùng đã xác thực.

Liệt kê các robot mà khách hàng đã xác thực đã đăng ký, mới nhất trước, tối đa 50 mục. Dấu thời gian theo ISO 8601; last_online và last_heartbeat là null cho đến khi robot đã kết nối một lần.

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

Đăng ký một robot mới và trả về id của nó. Một hardware id của bo mạch động cơ chỉ có thể thuộc về một robot; một xung đột sẽ bị từ chối với trạng thái 409.

Trả về hồ sơ khách hàng của người dùng đã xác thực.

Cập nhật các trường hồ sơ khách hàng.

Liệt kê các dataset cloud của khách hàng với số lượng episode và kích thước.

Liệt kê các hóa đơn hàng tháng của khách hàng.

Trả về thống kê sử dụng cho trang tổng quan khách hàng.

Trả về hồ sơ người vận hành của người dùng đã xác thực.

Tạo hoặc cập nhật hồ sơ người vận hành.

Liệt kê các robot hiện đang sẵn có và khớp với các chứng nhận của người vận hành.

Liệt kê các yêu cầu chứng nhận của người vận hành và trạng thái của chúng.

Yêu cầu chứng nhận cho một loại robot.

Trả về lịch trình sẵn sàng hàng tuần của người vận hành.

Cập nhật lịch trình sẵn sàng hàng tuần.

Trả về tính sẵn sàng hiện tại của người vận hành.

Trả về thống kê thu nhập và phiên cho trang tổng quan người vận hành.

Liệt kê các phiên cho người dùng đã xác thực. Người vận hành thấy các phiên họ đã vận hành; khách hàng thấy các phiên trên robot của họ. Tập trường khác nhau đôi chút giữa hai chế độ xem: chế độ xem khách hàng bao gồm episodes_collected và data_collected_mb, chế độ xem người vận hành bao gồm 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."
    }
  ]
}

Bắt đầu một phiên điều khiển từ xa trên một robot sẵn có. Yêu cầu vai trò người vận hành: khách hàng không thể bắt đầu phiên. Một người vận hành có thể giữ nhiều nhất một phiên ACTIVE hoặc PAUSED tại một thời điểm, và robot hiện tại phải có trạng thái AVAILABLE. Khi bắt đầu ngay lập tức, robot chuyển sang IN_SESSION và khách hàng được thông báo.

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

Trả về một phiên đơn lẻ với các chi tiết của nó.

Cập nhật vòng đời của phiên: tạm dừng, tiếp tục, kết thúc, và các hành động liên quan.

Yêu cầu gia hạn phiên. Chỉ khách hàng sở hữu phiên mới có thể gọi endpoint này, và phiên phải là ACTIVE. Yêu cầu được ghi lại như một sự kiện phiên và người vận hành nhận được thông báo; việc gia hạn thực sự xảy ra khi người vận hành hành động trên đó.

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

Liệt kê các tin nhắn chat của một phiên.

Gửi một tin nhắn chat trong một phiên.

Đánh giá một phiên đã hoàn thành trên thang điểm 1 đến 5 sao, kèm bình luận tùy chọn.

Xuất dữ liệu phiên.

Tạo hoặc trả về khách hàng Stripe được sử dụng cho thanh toán khách hàng.

Trả về trạng thái tài khoản Stripe Connect của người vận hành.

Bắt đầu onboarding Stripe Connect cho chi trả người vận hành.

Tạo một Stripe SetupIntent để lưu một phương thức thanh toán.

Tạo một phiên cổng thanh toán Stripe để quản lý phương thức thanh toán và hóa đơn.

Trả về thông tin chi trả cho người vận hành đã xác thực.

Yêu cầu một khoản chi trả từ thu nhập đã tích lũy. Khoản chi trả tối thiểu là 10,00 EUR.

Nhận các sự kiện webhook của Stripe. Được gọi bởi Stripe, không phải bởi các API client.

Kiểm tra sức khỏe cho API và kết nối cơ sở dữ liệu của nó. Trả về 200 khi cả hai đều ổn; nếu kiểm tra cơ sở dữ liệu thất bại, cùng cấu trúc được trả về với status và db được đặt thành error và trạng thái HTTP 503.

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

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

Trả về thông tin công khai về một mẫu robot được hỗ trợ.

Trả về các gói giá công khai hiện tại.

Gửi một tin nhắn biểu mẫu liên hệ. Tin nhắn được lưu trữ trước rồi mới được gửi qua email, vì vậy một sự cố mail tạm thời sẽ không làm mất nó: trong trường hợp đó phản hồi báo cáo stored true và delivered false, và việc gửi được thử lại về mặt vận hành.

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
}

Yêu cầu hỗ trợ cho một loại robot chưa có trên nền tảng.

Trả về thống kê công khai của nền tảng.