API viitematerjal
AY-Robots REST API asub aadressil https://www.ay-robots.com/api ja räägib mõlemas suunas JSON-i. See leht dokumenteerib autentimise, vastuste konventsioonid ja iga otspunkti, koos täieliku parameetrite dokumentatsiooniga marustuutidele, mida kõige tõenäolisemalt programmiliselt kutsute.
Viimati uuendatud 2026-08-09
Autentimine
Iga otspunkt nõuab autentimist, välja arvatud juhul, kui see on loetletud jaotises Public. API aktsepteerib kahte tüüpi mandaate ja mõlemad saabuvad samal viisil: kas töölaua poolt juba saadetava seansiküpsisena või Authorization päisena Bearer tokeniga.
| Meetod | Kuidas see töötab | Kasutage seda |
|---|---|---|
| Brauseri seanss | Teie sisselogitud konto Supabase seansitoken, saadetud küpsisena või Bearer tokenina | Töölaua enda jaoks ja kiirete katsete jaoks autentitud brauserikontekstist |
| API võti | Võti eesliitega ayr_live_, loodud aadressil /dashboard/settings ja saadetud Bearer tokenina | Skriptidele, serveritele, CI-le ja kõigele, mis ei tohi sõltuda brauserisse sisselogimisest |
| MCP | Hostitud MCP server aadressil https://www.ay-robots.com/api/mcp (Streamable HTTP) | LLM agentidele ja tööriistadele, mis räägivad Model Context Protocol'i |
curl https://www.ay-robots.com/api/sessions \
-H 'Authorization: Bearer ayr_live_your_key_here'API võtmed luuakse ja tühistatakse aadressil /dashboard/settings. Käsitlege neid nagu paroole: hoidke neid serveripoolel ja rotige, luues asendusvõtme enne vana tühistamist. Kui kasutate töölaua CLI-d, saab see platvormi ka kohaliku MCP serverina kättesaadavaks teha käsuga: ay-robots mcp.
Vastused on JSON. Vead kasutavad järjekindlat struktuuri: JSON objekt ühe error väljaga, mis sisaldab inimloetavat sõnumit, tarnituna sobiva 4xx või 5xx olekukoodiga. Edukad vastused tagastavad ressursi otse; mõned otspunktid mähivad loendid nimetatud väljale, mida allolevad näited näitavad seal, kus see on oluline.
Auth otspunktid
Konto ja profiili torustik. Neid kasutab peamiselt töölaud ise, kuid need töötavad iga kehtiva mandaadiga.
/api/auth/profileBearer seansitoken või API võtiTagastab autenditud kasutaja profiili.
/api/auth/profileBearer seansitoken või API võtiUuendab profiiliväljasid, näiteks kuvatavat nime ja teavituseelistusi.
/api/auth/syncBearer seansitokenSünkroniseerib Supabase auth kasutaja platvormi kasutajakirjega.
/api/auth/check-onboardingBearer seansitokenTeatab, kas autenditud kasutaja on registreerumise lõpetanud.
/api/auth/avatarBearer seansitokenLaadib üles uue avatari pildi autenditud kasutajale.
Kliendi otspunktid
Kõik, mida roboti omanik haldab: registreeritud robotid, kliendiprofiil, andmestikud, arved ja töölaua statistika.
/api/client/robotsBearer seansitoken või API võti (kliendi roll)Loetleb autenditud kliendi registreeritud robotid, uuemad esimesena, kuni 50 kirjet. Ajatemplid on ISO 8601 kujul; last_online ja last_heartbeat on null, kuni robot pole kordagi ühendunud.
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 seansitoken või API võti (kliendi roll)Registreerib uue roboti ja tagastab selle id. Mootoriplaadi riistvara id saab kuuluda ainult ühele robotile; konflikt lükatakse tagasi olekuga 409.
/api/client/profileBearer seansitoken või API võti (kliendi roll)Tagastab autenditud kasutaja kliendiprofiili.
/api/client/profileBearer seansitoken või API võti (kliendi roll)Uuendab kliendiprofiili väljasid.
/api/client/datasetsBearer seansitoken või API võti (kliendi roll)Loetleb kliendi pilveandmestikud koos episoodide arvu ja suurustega.
/api/client/invoicesBearer seansitoken või API võti (kliendi roll)Loetleb kliendi igakuised arved.
/api/client/statsBearer seansitoken või API võti (kliendi roll)Tagastab kasutusstatistika kliendi töölaua jaoks.
Operaatori otspunktid
Operaatori pool: profiil ja saadavus, sertifikaadid, ajastamine ja teenistuse statistika.
/api/operator/profileBearer seansitoken või API võti (operaatori roll)Tagastab autenditud kasutaja operaatoriprofiili.
/api/operator/profileBearer seansitoken või API võti (operaatori roll)Loob või uuendab operaatoriprofiili.
/api/operator/available-robotsBearer seansitoken või API võti (operaatori roll)Loetleb robotid, mis on hetkel saadaval ja vastavad operaatori sertifikaatidele.
/api/operator/certificationsBearer seansitoken või API võti (operaatori roll)Loetleb operaatori sertifikaaditaotlused ja nende oleku.
/api/operator/certificationsBearer seansitoken või API võti (operaatori roll)Taotleb sertifikaati robotitüübi jaoks.
/api/operator/scheduleBearer seansitoken või API võti (operaatori roll)Tagastab operaatori iganädalase saadavuse graafiku.
/api/operator/scheduleBearer seansitoken või API võti (operaatori roll)Uuendab iganädalast saadavuse graafikut.
/api/operator/availabilityBearer seansitoken või API võti (operaatori roll)Tagastab operaatori praeguse saadavuse.
/api/operator/statsBearer seansitoken või API võti (operaatori roll)Tagastab teenistuse ja seansside statistika operaatori töölaua jaoks.
Seansid
Seansid on platvormi põhiressurss: üks seanss on üks pidev teleoperatsiooni kaasatus operaatori ja roboti vahel. Seansi olek liigub läbi PENDING, ACTIVE, PAUSED, COMPLETED ja CANCELLED.
/api/sessionsBearer seansitoken või API võtiLoetleb autenditud kasutaja seansid. Operaatorid näevad seansse, mida nad juhtisid; kliendid näevad seansse oma robotitel. Väljade komplekt erineb kahe vaate vahel veidi: kliendi vaates on episodes_collected ja data_collected_mb, operaatori vaates on operator_earnings_cents.
| Name | In | Type | Description |
|---|---|---|---|
| status | query | string | Valikuline. Filtreerib seansi oleku järgi, näiteks ACTIVE või COMPLETED. Jätke ära, et loetleda kõik. |
| limit | query | number | Valikuline. Lehe suurus, vaikimisi 50, maksimaalselt 100. |
| offset | query | number | Valikuline. Lehitsemise nihe, vaikimisi 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 seansitoken või API võti (operaatori roll)Alustab teleoperatsiooni seanssi saadaoleval robotil. Nõuab operaatori rolli: kliendid ei saa seansse alustada. Operaator saab korraga hoida kõige rohkem ühte ACTIVE või PAUSED seanssi ja robot peab hetkel olema olekus AVAILABLE. Kohese alustamise korral lülitub robot olekusse IN_SESSION ja klient saab teavituse.
| Name | In | Type | Description |
|---|---|---|---|
| robotId | body | string | Kohustuslik. Juhitava roboti id. Robot peab olema AVAILABLE. |
| operatorId | body | string | Valikuline. Selgesõnaline operaatori id; vaikimisi autenditud operaator. |
| scheduledFor | body | string (ISO 8601) | Valikuline. Ajastab seansi tulevasele ajale, selle asemel et seda kohe alustada. |
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 seansitoken või API võtiTagastab ühe seansi koos üksikasjadega.
/api/sessions/[id]Bearer seansitoken või API võtiUuendab seansi elutsüklit: pausile panek, jätkamine, lõpetamine ja seotud toimingud.
/api/sessions/[id]/extendBearer seansitoken või API võti (klient, seansi omanik)Taotleb seansi pikendamist. Seda saab kutsuda ainult klient, kellele seanss kuulub, ja seanss peab olema ACTIVE. Taotlus registreeritakse seansisündmusena ja operaator saab teavituse; pikendus ise toimub siis, kui operaator sellele reageerib.
| Name | In | Type | Description |
|---|---|---|---|
| id | path | string | Seansi id. |
| additionalMinutes | body | number | Taotletud pikenduse kestus minutites. |
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 seansitoken või API võtiLoetleb seansi vestlussõnumid.
/api/sessions/[id]/messagesBearer seansitoken või API võtiSaadab vestlussõnumi seansis.
/api/sessions/[id]/rateBearer seansitoken või API võti (klient)Hindab lõpetatud seanssi 1 kuni 5 tärniga skaalal, koos valikulise kommentaariga.
/api/sessions/exportBearer seansitoken või API võtiEkspordib seansi andmed.
Maksed
Kogu rahaliikumine toimub Stripe kaudu. Kliendi arveldus kasutab Stripe klienti salvestatud maksemeetodiga; operaatori väljamaksed kasutavad Stripe Connecti. Platvorm ise ei salvesta kunagi kaardi- ega pangaandmeid.
/api/stripe/customerBearer seansitoken (kliendi roll)Loob või tagastab Stripe kliendi, mida kasutatakse kliendi arvelduseks.
/api/stripe/connectBearer seansitoken (operaatori roll)Tagastab operaatori Stripe Connecti konto oleku.
/api/stripe/connectBearer seansitoken (operaatori roll)Alustab Stripe Connecti registreerumist operaatori väljamaksete jaoks.
/api/stripe/setup-intentBearer seansitoken (kliendi roll)Loob Stripe SetupIntenti maksemeetodi salvestamiseks.
/api/stripe/portalBearer seansitoken (kliendi roll)Loob Stripe arveldusportaali seansi maksemeetodite ja arvete haldamiseks.
/api/stripe/payoutBearer seansitoken (operaatori roll)Tagastab väljamakse info autenditud operaatorile.
/api/stripe/payoutBearer seansitoken (operaatori roll)Taotleb kogunenud teenistuse väljamakset. Minimaalne väljamakse on 10,00 EUR.
/api/stripe/webhookStripe webhook allkiriVõtab vastu Stripe webhook sündmusi. Kutsub Stripe, mitte API kliendid.
Avalikud otspunktid
Need otspunktid ei vaja autentimist. Neid on ohutu kutsuda jälgimisest, turunduslehtedelt või olekusondist.
/api/healthAPI ja selle andmebaasiühenduse tervisekontroll. Tagastab 200, kui mõlemad on korras; kui andmebaasi kontroll ebaõnnestub, tagastatakse sama struktuur, kus status ja db on seatud väärtusele error ja HTTP olekukoodiks 503.
curl https://www.ay-robots.com/api/health{
"status": "ok",
"db": "ok",
"timestamp": "2026-08-09T10:12:00.000Z"
}/api/robots/[id]Tagastab avaliku teabe toetatud robotimudeli kohta.
/api/public/pricingTagastab praegused avalikud hinnaplaanid.
/api/contactEsitab kontaktivormi sõnumi. Sõnum salvestatakse kõigepealt ja seejärel tarnitakse e-postiga, seega ajutine posti tõrge seda ei kaota: sellisel juhul teatab vastus stored true ja delivered false, ning tarnimist proovitakse operatiivselt uuesti.
| Name | In | Type | Description |
|---|---|---|---|
| name | body | string | Kohustuslik. Teie nimi. |
| body | string | Kohustuslik. Kehtiv e-posti aadress vastuse jaoks. | |
| category | body | string | Kohustuslik. Üks järgnevatest: General Inquiry, Bug Report, Feature Request, Sales & Pricing, Partnership, Career/Jobs, Technical Support, Billing & Payments, Press & Media, Other. |
| subject | body | string | Kohustuslik. Lühike teemarida. |
| message | body | string | Kohustuslik. Sõnumi sisu. |
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-requestTaotleb tuge robotitüübile, mida platvormil veel ei ole.
/api/statsTagastab avaliku platvormi statistika.
Kuidas AY-Robots kaitseb kontosid ja reaalajas roboti juhtimist: Supabase autentimine, rollimudel, API võtmed, seansikaitsed, auditilogi ja krüpteerimine.
Kuidas AY-Robots seansid töötavad: olekute muutumine PENDING kuni COMPLETED, iga tegevussündmus, seansi vestlus, hinnangud, pikendused ja treeningandmed.