API-referencia
Az AY-Robots REST API-ja a https://www.ay-robots.com/api alatt él, és mindkét irányban JSON-t beszél. Ez az oldal dokumentálja a hitelesítést, a válaszkonvenciókat és minden végpontot, teljes paraméter-dokumentációval azokhoz az útvonalakhoz, amelyeket a legvalószínűbb programozottan meghívni.
Utolsó frissítés 2026-08-09
Hitelesítés
Minden végpont hitelesítést igényel, kivéve, ha a Nyilvános végpontok szekcióban szerepel. Az API kétféle hitelesítő adatot fogad el, és mindkettő ugyanúgy érkezik: vagy a munkamenet-cookie-ként, amelyet az irányítópult amúgy is küld, vagy egy Bearer tokent tartalmazó Authorization fejlécként.
| Módszer | Hogyan működik | Mire használható |
|---|---|---|
| Böngésző-munkamenet | A bejelentkezett fiókjának Supabase munkamenet-tokenje, cookie-ként vagy Bearer tokenként küldve | Maga az irányítópult, és gyors kísérletek egy hitelesített böngészőkontextusból |
| API-kulcs | Az ayr_live_ előtaggal ellátott kulcs, amelyet a /dashboard/settings alatt hoz létre, és Bearer tokenként küld | Szkriptek, szerverek, CI és minden, aminek nem szabad böngészős bejelentkezéstől függenie |
| MCP | A hosztolt MCP szerver a https://www.ay-robots.com/api/mcp címen (Streamable HTTP) | LLM-ügynökök és eszközök, amelyek a Model Context Protocolt beszélik |
curl https://www.ay-robots.com/api/sessions \
-H 'Authorization: Bearer ayr_live_your_key_here'Az API-kulcsokat a /dashboard/settings alatt hozza létre és vonja vissza. Kezelje őket jelszóként: tartsa őket a szerver oldalán, és úgy rotálja őket, hogy előbb létrehoz egy csere-kulcsot, mielőtt visszavonná a régit. Ha a desktop CLI-t használja, az a platformot helyi MCP szerverként is elérhetővé teheti a következő paranccsal: ay-robots mcp.
A válaszok JSON formátumúak. A hibák egységes alakot követnek: egy JSON objektum egyetlen error mezővel, amely emberi olvasásra szánt üzenetet tartalmaz, a megfelelő 4xx vagy 5xx státuszkóddal együtt kézbesítve. A sikeres válaszok közvetlenül visszaadják az erőforrást; néhány végpont egy elnevezett mezőbe csomagolja a listákat, amit az alábbi példák ott mutatnak, ahol számít.
Hitelesítési végpontok
Fiók- és profilkezelés. Ezeket a végpontokat elsősorban maga az irányítópult használja, de bármilyen érvényes hitelesítő adattal működnek.
/api/auth/profileBearer munkamenet-token vagy API-kulcsVisszaadja a hitelesített felhasználó profilját.
/api/auth/profileBearer munkamenet-token vagy API-kulcsFrissíti a profilmezőket, például a megjelenítendő nevet és az értesítési beállításokat.
/api/auth/syncBearer munkamenet-tokenSzinkronizálja a Supabase Auth felhasználót a platform felhasználói rekordjával.
/api/auth/check-onboardingBearer munkamenet-tokenJelenti, hogy a hitelesített felhasználó befejezte-e az onboardingot.
/api/auth/avatarBearer munkamenet-tokenFeltölt egy új avatárképet a hitelesített felhasználó számára.
Ügyfél-végpontok
Minden, amit egy robottulajdonos kezel: regisztrált robotok, ügyfélprofil, adatkészletek, számlák és irányítópult-statisztikák.
/api/client/robotsBearer munkamenet-token vagy API-kulcs (ügyfél szerepkör)Felsorolja a hitelesített ügyfél által regisztrált robotokat, legújabb elöl, legfeljebb 50 bejegyzésig. Az időbélyegek ISO 8601 formátumúak; a last_online és a last_heartbeat null, amíg a robot egyszer sem csatlakozott.
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"
}
]/api/client/robotsBearer munkamenet-token vagy API-kulcs (ügyfél szerepkör)Regisztrál egy új robotot, és visszaadja az id-jét. Egy motorpanel hardver-id-je csak egyetlen robothoz tartozhat; egy ütközés 409-es státusszal elutasításra kerül.
/api/client/profileBearer munkamenet-token vagy API-kulcs (ügyfél szerepkör)Visszaadja a hitelesített felhasználó ügyfélprofilját.
/api/client/profileBearer munkamenet-token vagy API-kulcs (ügyfél szerepkör)Frissíti az ügyfélprofil mezőit.
/api/client/datasetsBearer munkamenet-token vagy API-kulcs (ügyfél szerepkör)Felsorolja az ügyfél felhő-adatkészleteit epizódszámmal és mérettel.
/api/client/invoicesBearer munkamenet-token vagy API-kulcs (ügyfél szerepkör)Felsorolja az ügyfél havi számláit.
/api/client/statsBearer munkamenet-token vagy API-kulcs (ügyfél szerepkör)Visszaadja a használati statisztikákat az ügyfél-irányítópulthoz.
Operátor-végpontok
Az operátor oldala: profil és elérhetőség, minősítések, ütemezés és keresetstatisztikák.
/api/operator/profileBearer munkamenet-token vagy API-kulcs (operátor szerepkör)Visszaadja a hitelesített felhasználó operátori profilját.
/api/operator/profileBearer munkamenet-token vagy API-kulcs (operátor szerepkör)Létrehozza vagy frissíti az operátori profilt.
/api/operator/available-robotsBearer munkamenet-token vagy API-kulcs (operátor szerepkör)Felsorolja az éppen elérhető és az operátor minősítéseinek megfelelő robotokat.
/api/operator/certificationsBearer munkamenet-token vagy API-kulcs (operátor szerepkör)Felsorolja az operátor minősítési kérelmeit és azok állapotát.
/api/operator/certificationsBearer munkamenet-token vagy API-kulcs (operátor szerepkör)Minősítést kér egy robottípushoz.
/api/operator/scheduleBearer munkamenet-token vagy API-kulcs (operátor szerepkör)Visszaadja az operátor heti elérhetőségi beosztását.
/api/operator/scheduleBearer munkamenet-token vagy API-kulcs (operátor szerepkör)Frissíti a heti elérhetőségi beosztást.
/api/operator/availabilityBearer munkamenet-token vagy API-kulcs (operátor szerepkör)Visszaadja az operátor jelenlegi elérhetőségét.
/api/operator/statsBearer munkamenet-token vagy API-kulcs (operátor szerepkör)Visszaadja a kereset- és munkamenet-statisztikákat az operátor-irányítópulthoz.
Munkamenetek
A munkamenetek a platform alaperőforrása: egy munkamenet egy folyamatos teleoperációs elköteleződés egy operátor és egy robot között. A munkamenet állapota PENDING, ACTIVE, PAUSED, COMPLETED és CANCELLED között mozog.
/api/sessionsBearer munkamenet-token vagy API-kulcsFelsorolja a hitelesített felhasználó munkameneteit. Az operátorok azokat a munkameneteket látják, amelyeket ők vezettek; az ügyfelek a saját robotjaikon futottakat. A mezőkészlet kissé eltér a két nézet között: az ügyfélnézet tartalmazza az episodes_collected és a data_collected_mb mezőket, az operátori nézet az operator_earnings_cents mezőt.
| Name | In | Type | Description |
|---|---|---|---|
| status | query | string | Opcionális. Szűrés munkamenet-állapot szerint, például ACTIVE vagy COMPLETED. Hagyja el az összes felsorolásához. |
| limit | query | number | Opcionális. Oldalméret, alapértelmezetten 50, legfeljebb 100. |
| offset | query | number | Opcionális. Lapozási eltolás, alapértelmezetten 0. |
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."
}
]
}/api/sessionsBearer munkamenet-token vagy API-kulcs (operátor szerepkör)Elindít egy teleoperációs munkamenetet egy elérhető robotnál. Operátor szerepkört igényel: ügyfelek nem indíthatnak munkamenetet. Egy operátor egyszerre legfeljebb egy ACTIVE vagy PAUSED munkamenetet tarthat, és a robotnak jelenleg AVAILABLE állapotúnak kell lennie. Azonnali indításnál a robot IN_SESSION állapotra vált, és az ügyfél értesítést kap.
| Name | In | Type | Description |
|---|---|---|---|
| robotId | body | string | Kötelező. A vezérelni kívánt robot id-je. A robotnak AVAILABLE állapotúnak kell lennie. |
| operatorId | body | string | Opcionális. Explicit operátor-id; alapértelmezetten a hitelesített operátor. |
| scheduledFor | body | string (ISO 8601) | Opcionális. Egy jövőbeli időpontra ütemezi a munkamenetet, ahelyett hogy azonnal elindítaná. |
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"
}/api/sessions/[id]Bearer munkamenet-token vagy API-kulcsVisszaad egyetlen munkamenetet a részleteivel.
/api/sessions/[id]Bearer munkamenet-token vagy API-kulcsFrissíti a munkamenet életciklusát: szüneteltetés, folytatás, befejezés és kapcsolódó műveletek.
/api/sessions/[id]/extendBearer munkamenet-token vagy API-kulcs (ügyfél, a munkamenet tulajdonosa)Munkamenet-hosszabbítást kér. Ezt csak az az ügyfél hívhatja meg, akié a munkamenet, és a munkamenetnek ACTIVE állapotúnak kell lennie. A kérés munkamenet-eseményként kerül naplózásra, és az operátor értesítést kap; maga a hosszabbítás akkor történik meg, amikor az operátor reagál rá.
| Name | In | Type | Description |
|---|---|---|---|
| id | path | string | A munkamenet id-je. |
| additionalMinutes | body | number | A kért hosszabbítás hossza percekben. |
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"
}/api/sessions/[id]/messagesBearer munkamenet-token vagy API-kulcsFelsorolja egy munkamenet chatüzeneteit.
/api/sessions/[id]/messagesBearer munkamenet-token vagy API-kulcsChatüzenetet küld egy munkamenetben.
/api/sessions/[id]/rateBearer munkamenet-token vagy API-kulcs (ügyfél)Egy befejezett munkamenetet 1-től 5 csillagig terjedő skálán értékel, opcionális megjegyzéssel.
/api/sessions/exportBearer munkamenet-token vagy API-kulcsExportálja a munkamenet adatait.
Fizetések
Minden pénzmozgás a Stripe-on keresztül zajlik. Az ügyfélszámlázás egy mentett fizetési móddal rendelkező Stripe ügyfelet használ; az operátori kifizetések a Stripe Connectet. Maga a platform soha nem tárol kártya- vagy bankadatot.
/api/stripe/customerBearer munkamenet-token (ügyfél szerepkör)Létrehozza vagy visszaadja az ügyfélszámlázáshoz használt Stripe ügyfelet.
/api/stripe/connectBearer munkamenet-token (operátor szerepkör)Visszaadja az operátor Stripe Connect fiókjának állapotát.
/api/stripe/connectBearer munkamenet-token (operátor szerepkör)Elindítja a Stripe Connect onboardingot az operátori kifizetésekhez.
/api/stripe/setup-intentBearer munkamenet-token (ügyfél szerepkör)Létrehoz egy Stripe SetupIntentet egy fizetési mód mentéséhez.
/api/stripe/portalBearer munkamenet-token (ügyfél szerepkör)Létrehoz egy Stripe billing portál munkamenetet a fizetési módok és számlák kezeléséhez.
/api/stripe/payoutBearer munkamenet-token (operátor szerepkör)Visszaadja a hitelesített operátor kifizetési adatait.
/api/stripe/payoutBearer munkamenet-token (operátor szerepkör)Kifizetést kér a felhalmozott keresetekből. A minimum kifizetés 10,00 EUR.
/api/stripe/webhookStripe webhook aláírásFogadja a Stripe webhook eseményeit. A Stripe hívja, nem az API kliensei.
Nyilvános végpontok
Ezek a végpontok nem igényelnek hitelesítést. Biztonságosan hívhatók monitoringból, marketingoldalakról vagy egy állapotszondából.
/api/healthÁllapotellenőrzés az API-hoz és annak adatbázis-kapcsolatához. 200-at ad vissza, ha minden rendben; ha az adatbázis-ellenőrzés sikertelen, ugyanaz az alak érkezik vissza, a status és a db mezővel error-ra állítva, 503-as HTTP státusszal.
curl https://www.ay-robots.com/api/health{
"status": "ok",
"db": "ok",
"timestamp": "2026-08-09T10:12:00.000Z"
}/api/robots/[id]Visszaad nyilvános információt egy támogatott robotmodellről.
/api/public/pricingVisszaadja az aktuális nyilvános árazási csomagokat.
/api/contactBeküld egy kapcsolatfelvételi űrlap üzenetet. Az üzenet előbb tárolásra kerül, majd e-mailben kézbesítik, így egy átmeneti levélkiesés nem veszíti el: ebben az esetben a válasz stored true és delivered false értéket jelent, és a kézbesítést üzemeltetői oldalon újrapróbálják.
| Name | In | Type | Description |
|---|---|---|---|
| name | body | string | Kötelező. Az ön neve. |
| body | string | Kötelező. Érvényes e-mail-cím a válaszhoz. | |
| category | body | string | Kötelező. Az egyik a következők közül: General Inquiry, Bug Report, Feature Request, Sales & Pricing, Partnership, Career/Jobs, Technical Support, Billing & Payments, Press & Media, Other. |
| subject | body | string | Kötelező. Rövid tárgy. |
| message | body | string | Kötelező. Az üzenet szövege. |
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
}/api/robot-requestTámogatást kér egy még nem szereplő robottípushoz a platformon.
/api/statsVisszaadja a nyilvános platformstatisztikákat.
Hogyan biztosítja az AY-Robots a fiókokat és az élő robotvezérlést: hitelesítés, szerepkörök, API-kulcsok, munkamenet-védelem és titkosítás.
Hogyan működnek az AY-Robots munkamenetek: PENDING-től COMPLETED-ig az életciklus, aktivitási események, chat, értékelések és tréningadatok.