API-довідник

Повертає профіль автентифікованого користувача.

Оновлює поля профілю, такі як відображуване ім'я і налаштування сповіщень.

Синхронізує користувача автентифікації Supabase із записом користувача платформи.

Повідомляє, чи завершив автентифікований користувач онбординг.

Завантажує нове зображення аватара для автентифікованого користувача.

Перелічує роботів, зареєстрованих автентифікованим клієнтом, спочатку найновіші, до 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 оператора.

Запускає онбординг Stripe Connect для виплат оператору.

Створює Stripe SetupIntent для збереження способу оплати.

Створює сесію білінгового порталу Stripe для керування способами оплати і рахунками.

Повертає інформацію про виплати для автентифікованого оператора.

Запитує виплату накопиченого заробітку. Мінімальна виплата становить 10,00 EUR.

Приймає webhook-події Stripe. Викликається Stripe, а не клієнтами API.

Перевірка здоров'я 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
}

Запитує підтримку типу робота, якого ще немає на платформі.

Повертає публічну статистику платформи.