API reference

پروفایل کاربر احراز هویت شده را برمی گرداند.

فیلدهای پروفایل مانند نام نمایشی و ترجیحات اعلان را به روز می کند.

کاربر 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.

بررسی تندرستی برای 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
}

پشتیبانی برای یک نوع ربات که هنوز روی پلتفرم نیست را درخواست می کند.

آمار عمومی پلتفرم را برمی گرداند.