API reference

Returns the profile of the authenticated user.

Updates profile fields such as the display name and notification preferences.

Synchronizes the Supabase auth user with the platform user record.

Reports whether the authenticated user has completed onboarding.

Uploads a new avatar image for the authenticated user.

Lists the robots registered by the authenticated client, newest first, up to 50 entries. Timestamps are ISO 8601; last_online and last_heartbeat are null until the robot has connected once.

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

Registers a new robot and returns its id. A motor board hardware id can belong to only one robot; a collision is rejected with status 409.

Returns the client profile of the authenticated user.

Updates client profile fields.

Lists the client's cloud datasets with episode counts and sizes.

Lists the client's monthly invoices.

Returns usage statistics for the client dashboard.

Returns the operator profile of the authenticated user.

Creates or updates the operator profile.

Lists robots that are currently available and match the operator's certifications.

Lists the operator's certification requests and their status.

Requests certification for a robot type.

Returns the operator's weekly availability schedule.

Updates the weekly availability schedule.

Returns the operator's current availability.

Returns earnings and session statistics for the operator dashboard.

Lists sessions for the authenticated user. Operators see sessions they operated; clients see sessions on their robots. The field set differs slightly between the two views: the client view includes episodes_collected and data_collected_mb, the operator view includes 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."
    }
  ]
}

Starts a teleoperation session on an available robot. Requires the operator role: clients cannot start sessions. An operator can hold at most one ACTIVE or PAUSED session at a time, and the robot must currently have status AVAILABLE. On an immediate start the robot switches to IN_SESSION and the client is notified.

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

Returns a single session with its details.

Updates the session lifecycle: pause, resume, end, and related actions.

Requests a session extension. Only the client who owns the session can call this, and the session must be ACTIVE. The request is logged as a session event and the operator receives a notification; the extension itself happens when the operator acts on it.

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

Lists the chat messages of a session.

Sends a chat message in a session.

Rates a completed session on a 1 to 5 star scale, with an optional comment.

Exports session data.

Creates or returns the Stripe customer used for client billing.

Returns the status of the operator's Stripe Connect account.

Starts Stripe Connect onboarding for operator payouts.

Creates a Stripe SetupIntent for saving a payment method.

Creates a Stripe billing portal session for managing payment methods and invoices.

Returns payout information for the authenticated operator.

Requests a payout of accumulated earnings. The minimum payout is 10.00 EUR.

Receives Stripe webhook events. Called by Stripe, not by API clients.

Health check for the API and its database connection. Returns 200 when both are fine; if the database check fails, the same shape is returned with status and db set to error and HTTP status 503.

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

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

Returns public information about a supported robot model.

Returns the current public pricing plans.

Submits a contact form message. The message is stored first and then delivered by email, so a temporary mail outage does not lose it: in that case the response reports stored true and delivered false, and delivery is retried operationally.

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
}

Requests support for a robot type that is not yet on the platform.

Returns public platform statistics.