API-tilvísun

REST API AY-Robots er á https://www.ay-robots.com/api og talar JSON í báðar áttir. Þessi síða skjalfestir auðkenningu, svarvenjur og hvern endapunkt, með fullri breytuskjölun fyrir slóðirnar sem þú kallar líklegast á forritunarlegan hátt.

Síðast uppfært 2026-08-09

Auðkenning

Hver endapunktur krefst auðkenningar nema hann sé talinn upp í kaflanum Opinberir endapunktar. API tekur við tveimur tegundum af gögnum og bæði berast á sama hátt: annaðhvort sem setu-vefkakan sem mælaborðið sendir hvort sem er, eða sem Authorization haus með Bearer tákni.

AðferðHvernig hún virkarNotaðu hana fyrir
Setu í vafraSupabase setu-tákn innskráða reikningsins þíns, sent sem vefkaka eða sem Bearer táknMælaborðið sjálft og fljótlegar tilraunir úr auðkenndu vafraumhverfi
API-lykillLykill með forskeytinu ayr_live_, búinn til í /dashboard/settings og sendur sem Bearer táknSkriftur, netþjónar, CI og allt sem má ekki vera háð innskráningu í vafra
MCPHýsti MCP-þjónninn á https://www.ay-robots.com/api/mcp (Streamable HTTP)LLM-umboðsmenn og verkfæri sem tala Model Context Protocol
bash
curl https://www.ay-robots.com/api/sessions \
  -H 'Authorization: Bearer ayr_live_your_key_here'
Auðkenning með API-lykli

API-lyklar eru búnir til og afturkallaðir í /dashboard/settings. Farðu með þá eins og lykilorð: geymdu þá á netþjónahliðinni og skiptu um með því að búa fyrst til nýjan lykil áður en þú afturkallar þann gamla. Ef þú notar skjáborðs-CLI getur það líka gert kerfið aðgengilegt sem MCP-þjón á staðnum með skipuninni: ay-robots mcp.

Svör eru JSON. Villur hafa samræmda lögun: JSON hlutur með einu error sviði sem inniheldur skiljanlegan texta, afhent með viðeigandi 4xx eða 5xx stöðukóða. Vel heppnuð svör skila auðlindinni beint; nokkrir endapunktar vefja lista í nefnt svið, sem dæmin hér að neðan sýna þar sem það skiptir máli.

Auth-endapunktar

Reikninga- og notandasniðsvinna. Þessa endapunkta notar aðallega mælaborðið sjálft, en þeir virka með hvaða gildu auðkenni sem er.

GET/api/auth/profileBearer setu-tákn eða API-lykill

Skilar notandasniði auðkennda notandans.

POST/api/auth/profileBearer setu-tákn eða API-lykill

Uppfærir svið notandasniðs eins og birtingarnafnið og tilkynningastillingar.

POST/api/auth/syncBearer setu-tákn

Samstillir Supabase auth-notandann við notandaskráningu kerfisins.

GET/api/auth/check-onboardingBearer setu-tákn

Segir til um hvort auðkenndi notandinn hafi lokið nýskráningu.

POST/api/auth/avatarBearer setu-tákn

Hleður upp nýrri auðkennismynd fyrir auðkennda notandann.

Endapunktar viðskiptavina

Allt sem eigandi vélmennis stýrir: skráð vélmenni, notandasnið viðskiptavinar, gagnasöfn, reikningar og tölfræði mælaborðsins.

GET/api/client/robotsBearer setu-tákn eða API-lykill (viðskiptavinahlutverk)

Telur upp vélmenni skráð af auðkennda viðskiptavininum, nýjasta fyrst, allt að 50 færslur. Tímastimplar eru ISO 8601; last_online og last_heartbeat eru null þar til vélmennið hefur tengst einu sinni.

Request
curl https://www.ay-robots.com/api/client/robots \
  -H 'Authorization: Bearer ayr_live_your_key_here'
Response
[
  {
    "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"
  }
]
POST/api/client/robotsBearer setu-tákn eða API-lykill (viðskiptavinahlutverk)

Skráir nýtt vélmenni og skilar auðkenni þess. Vélbúnaðarauðkenni mótorborðs getur aðeins tilheyrt einu vélmenni; árekstri er hafnað með stöðu 409.

GET/api/client/profileBearer setu-tákn eða API-lykill (viðskiptavinahlutverk)

Skilar notandasniði viðskiptavinar hjá auðkennda notandanum.

PATCH/api/client/profileBearer setu-tákn eða API-lykill (viðskiptavinahlutverk)

Uppfærir svið notandasniðs viðskiptavinar.

GET/api/client/datasetsBearer setu-tákn eða API-lykill (viðskiptavinahlutverk)

Telur upp skýjagagnasöfn viðskiptavinarins með lotufjölda og stærðum.

GET/api/client/invoicesBearer setu-tákn eða API-lykill (viðskiptavinahlutverk)

Telur upp mánaðarlega reikninga viðskiptavinarins.

GET/api/client/statsBearer setu-tákn eða API-lykill (viðskiptavinahlutverk)

Skilar notkunartölfræði fyrir mælaborð viðskiptavinar.

Endapunktar stjórnanda

Hlið stjórnandans: notandasnið og tiltæki, vottanir, tímasetning og tekjutölfræði.

GET/api/operator/profileBearer setu-tákn eða API-lykill (stjórnandahlutverk)

Skilar notandasniði stjórnanda hjá auðkennda notandanum.

POST/api/operator/profileBearer setu-tákn eða API-lykill (stjórnandahlutverk)

Býr til eða uppfærir notandasnið stjórnanda.

GET/api/operator/available-robotsBearer setu-tákn eða API-lykill (stjórnandahlutverk)

Telur upp vélmenni sem eru laus núna og passa við vottanir stjórnandans.

GET/api/operator/certificationsBearer setu-tákn eða API-lykill (stjórnandahlutverk)

Telur upp vottunarbeiðnir stjórnandans og stöðu þeirra.

POST/api/operator/certificationsBearer setu-tákn eða API-lykill (stjórnandahlutverk)

Sækir um vottun fyrir vélmennitegund.

GET/api/operator/scheduleBearer setu-tákn eða API-lykill (stjórnandahlutverk)

Skilar vikulegri tiltækisáætlun stjórnandans.

POST/api/operator/scheduleBearer setu-tákn eða API-lykill (stjórnandahlutverk)

Uppfærir vikulegu tiltækisáætlunina.

GET/api/operator/availabilityBearer setu-tákn eða API-lykill (stjórnandahlutverk)

Skilar núverandi tiltæki stjórnandans.

GET/api/operator/statsBearer setu-tákn eða API-lykill (stjórnandahlutverk)

Skilar tekju- og setutölfræði fyrir mælaborð stjórnanda.

Setur

Setur eru kjarnaauðlind kerfisins: ein seta er eitt samfellt fjarstýringarsamband milli stjórnanda og vélmennis. Staða setu fer í gegnum PENDING, ACTIVE, PAUSED, COMPLETED og CANCELLED.

GET/api/sessionsBearer setu-tákn eða API-lykill

Telur upp setur fyrir auðkennda notandann. Stjórnendur sjá setur sem þeir stýrðu; viðskiptavinir sjá setur á sínum vélmennum. Sviðamengin eru örlítið ólík milli sýnanna tveggja: sýn viðskiptavinar inniheldur episodes_collected og data_collected_mb, sýn stjórnanda inniheldur operator_earnings_cents.

NameInTypeDescription
statusquerystringValfrjálst. Síar eftir stöðu setu, til dæmis ACTIVE eða COMPLETED. Sleppa til að telja upp allar.
limitquerynumberValfrjálst. Blaðsíðustærð, sjálfgefið 50, hámark 100.
offsetquerynumberValfrjálst. Síðuskiptingarhliðrun, sjálfgefið 0.
Request
curl 'https://www.ay-robots.com/api/sessions?status=COMPLETED&limit=10' \
  -H 'Authorization: Bearer ayr_live_your_key_here'
Response
{
  "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."
    }
  ]
}
POST/api/sessionsBearer setu-tákn eða API-lykill (stjórnandahlutverk)

Ræsir fjarstýringarsetu á lausu vélmenni. Krefst stjórnandahlutverks: viðskiptavinir geta ekki ræst setur. Stjórnandi getur haldið að hámarki einni ACTIVE eða PAUSED setu í einu, og vélmennið verður að hafa stöðuna AVAILABLE. Við samstundis ræsingu skiptir vélmennið yfir í IN_SESSION og viðskiptavinurinn fær tilkynningu.

NameInTypeDescription
robotIdbodystringNauðsynlegt. Auðkenni vélmennisins sem á að stýra. Vélmennið verður að vera AVAILABLE.
operatorIdbodystringValfrjálst. Skýrt auðkenni stjórnanda; sjálfgefið er auðkenndi stjórnandinn.
scheduledForbodystring (ISO 8601)Valfrjálst. Áætlar setuna á framtíðartíma í stað þess að ræsa hana samstundis.
Request
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"}'
Response
{
  "sessionId": "6b0d2c9a-53f1-4f6e-8f1a-2c9d4e7b5a30",
  "status": "ACTIVE"
}
GET/api/sessions/[id]Bearer setu-tákn eða API-lykill

Skilar einni setu með smáatriðum hennar.

PATCH/api/sessions/[id]Bearer setu-tákn eða API-lykill

Uppfærir lífsferil setu: setja á bið, halda áfram, enda og tengdar aðgerðir.

POST/api/sessions/[id]/extendBearer setu-tákn eða API-lykill (viðskiptavinur, eigandi setu)

Sækir um framlengingu setu. Aðeins viðskiptavinurinn sem á setuna getur kallað á þetta, og setan verður að vera ACTIVE. Beiðnin er skráð sem atburður setu og stjórnandinn fær tilkynningu; sjálf framlengingin gerist þegar stjórnandinn bregst við henni.

NameInTypeDescription
idpathstringAuðkenni setunnar.
additionalMinutesbodynumberUmbeðin lengd framlengingar í mínútum.
Request
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}'
Response
{
  "message": "Extension request sent to operator"
}
GET/api/sessions/[id]/messagesBearer setu-tákn eða API-lykill

Telur upp spjallskilaboð setu.

POST/api/sessions/[id]/messagesBearer setu-tákn eða API-lykill

Sendir spjallskilaboð í setu.

POST/api/sessions/[id]/rateBearer setu-tákn eða API-lykill (viðskiptavinur)

Gefur kláraðri setu einkunn á kvarðanum 1 til 5 stjörnur, með valfrjálsri athugasemd.

POST/api/sessions/exportBearer setu-tákn eða API-lykill

Flytur út gögn setu.

Greiðslur

Öll peningahreyfing fer í gegnum Stripe. Greiðslur viðskiptavinar nota Stripe-viðskiptavin með vistaðri greiðsluaðferð, útborganir stjórnanda nota Stripe Connect. Kerfið sjálft geymir aldrei kort- eða bankagögn.

POST/api/stripe/customerBearer setu-tákn (viðskiptavinahlutverk)

Býr til eða skilar Stripe-viðskiptavininum sem er notaður fyrir greiðslur viðskiptavinar.

GET/api/stripe/connectBearer setu-tákn (stjórnandahlutverk)

Skilar stöðu Stripe Connect reiknings stjórnandans.

POST/api/stripe/connectBearer setu-tákn (stjórnandahlutverk)

Ræsir Stripe Connect nýskráningu fyrir útborganir stjórnanda.

POST/api/stripe/setup-intentBearer setu-tákn (viðskiptavinahlutverk)

Býr til Stripe SetupIntent til að vista greiðsluaðferð.

POST/api/stripe/portalBearer setu-tákn (viðskiptavinahlutverk)

Býr til Stripe billing portal setu til að stýra greiðsluaðferðum og reikningum.

GET/api/stripe/payoutBearer setu-tákn (stjórnandahlutverk)

Skilar útborgunarupplýsingum fyrir auðkennda stjórnandann.

POST/api/stripe/payoutBearer setu-tákn (stjórnandahlutverk)

Sækir um útborgun uppsafnaðra tekna. Lágmarksútborgun er 10,00 EUR.

POST/api/stripe/webhookStripe webhook undirskrift

Tekur við Stripe webhook-atburðum. Kallað af Stripe, ekki af API-biðlurum.

Opinberir endapunktar

Þessir endapunktar krefjast engrar auðkenningar. Óhætt er að kalla á þá úr eftirliti, markaðssíðum eða stöðuprófun.

GET/api/health

Heilbrigðisathugun fyrir API-ið og gagnagrunnstengingu þess. Skilar 200 þegar hvort tveggja er í lagi; ef gagnagrunnsathugunin mistekst kemur sama lögun til baka með status og db stillt á error og HTTP stöðu 503.

Request
curl https://www.ay-robots.com/api/health
Response
{
  "status": "ok",
  "db": "ok",
  "timestamp": "2026-08-09T10:12:00.000Z"
}
GET/api/robots/[id]

Skilar opinberum upplýsingum um studda vélmennitegund.

GET/api/public/pricing

Skilar núverandi opinberum verðáætlunum.

POST/api/contact

Sendir inn skilaboð úr tengiliðaforminu. Skilaboðin eru fyrst vistuð og síðan afhent með tölvupósti, svo tímabundin bilun í pósti tapar þeim ekki: í því tilviki tilkynnir svarið stored true og delivered false, og afhendingin er endurtekin í rekstri.

NameInTypeDescription
namebodystringNauðsynlegt. Nafnið þitt.
emailbodystringNauðsynlegt. Gilt tölvupóstfang fyrir svar.
categorybodystringNauðsynlegt. Eitt af: General Inquiry, Bug Report, Feature Request, Sales & Pricing, Partnership, Career/Jobs, Technical Support, Billing & Payments, Press & Media, Other.
subjectbodystringNauðsynlegt. Stutt efnislína.
messagebodystringNauðsynlegt. Meginmál skilaboðanna.
Request
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."
  }'
Response
{
  "success": true,
  "message": "Message sent successfully",
  "id": "b1f2c3d4-0000-0000-0000-000000000000",
  "stored": true,
  "delivered": true
}
POST/api/robot-request

Óskar eftir stuðningi fyrir vélmennitegund sem er ekki enn á kerfinu.

GET/api/stats

Skilar opinberri tölfræði kerfisins.