API రిఫరెన్స్
AY-Robots REST API https://www.ay-robots.com/api కింద ఉంటుంది, రెండు దిశల్లోనూ JSON మాట్లాడుతుంది. ఈ పేజీ ఆథెంటికేషన్ను, రెస్పాన్స్ కన్వెన్షన్లను, ప్రతి ఎండ్పాయింట్ను డాక్యుమెంట్ చేస్తుంది, మీరు ప్రోగ్రామాటిక్గా అత్యధికంగా కాల్ చేయగల రూట్ల కోసం పూర్తి పారామీటర్ డాక్యుమెంటేషన్తో సహా.
చివరిగా అప్డేట్ చేయబడింది 2026-08-09
ఆథెంటికేషన్
Public విభాగంలో జాబితా చేయబడకపోతే ప్రతి ఎండ్పాయింట్కు ఆథెంటికేషన్ అవసరం. API రెండు రకాల క్రెడెన్షియల్లను ఆమోదిస్తుంది, రెండూ ఒకే విధంగా వస్తాయి: డాష్బోర్డ్ ఇప్పటికే పంపే సెషన్ కుకీగా, లేదా ఒక Bearer టోకెన్తో ఒక Authorization హెడర్గా.
| పద్ధతి | ఇది ఎలా పనిచేస్తుంది | దీనికి ఉపయోగించండి |
|---|---|---|
| బ్రౌజర్ సెషన్ | మీ లాగిన్ అయిన ఖాతా యొక్క Supabase సెషన్ టోకెన్, ఒక కుకీగా లేదా Bearer టోకెన్గా పంపబడుతుంది | డాష్బోర్డ్ స్వయంగా, ఆథెంటికేటెడ్ బ్రౌజర్ సందర్భం నుండి త్వరిత ప్రయోగాలు |
| API కీ | ayr_live_ ప్రిఫిక్స్ ఉన్న ఒక కీ, /dashboard/settings లో సృష్టించబడి Bearer టోకెన్గా పంపబడుతుంది | స్క్రిప్ట్లు, సర్వర్లు, CI, బ్రౌజర్ లాగిన్పై ఆధారపడకూడని ఏదైనా |
| MCP | https://www.ay-robots.com/api/mcp వద్ద హోస్ట్ చేయబడిన MCP సర్వర్ (Streamable HTTP) | Model Context Protocol మాట్లాడే LLM ఏజెంట్లు, టూల్లు |
curl https://www.ay-robots.com/api/sessions \
-H 'Authorization: Bearer ayr_live_your_key_here'API కీలు /dashboard/settings లో సృష్టించబడతాయి, రద్దు చేయబడతాయి. వాటిని పాస్వర్డ్ల వలె పరిగణించండి: వాటిని సర్వర్-సైడ్లో ఉంచండి, పాతదాన్ని రద్దు చేయడానికి ముందు ఒక రీప్లేస్మెంట్ కీని సృష్టించి రొటేట్ చేయండి. మీరు డెస్క్టాప్ CLI ను ఉపయోగిస్తుంటే, అది ay-robots mcp అనే కమాండ్తో ప్లాట్ఫారమ్ను ఒక స్థానిక MCP సర్వర్గా కూడా బహిర్గతం చేయగలదు.
రెస్పాన్స్లు JSON. ఎర్రర్లు ఒక స్థిరమైన ఆకారంలో ఉంటాయి: మనిషి చదవగలిగే సందేశాన్ని కలిగి ఉన్న ఒక error ఫీల్డ్తో ఒక JSON ఆబ్జెక్ట్, తగిన 4xx లేదా 5xx స్టేటస్ కోడ్తో అందించబడుతుంది. విజయవంతమైన రెస్పాన్స్లు రిసోర్స్ను నేరుగా తిరిగి ఇస్తాయి; కొన్ని ఎండ్పాయింట్లు జాబితాలను ఒక పేరున్న ఫీల్డ్లో ర్యాప్ చేస్తాయి, కింద ఉన్న ఉదాహరణలు అది ముఖ్యమైన చోట్ల చూపిస్తాయి.
Auth ఎండ్పాయింట్లు
ఖాతా, ప్రొఫైల్ సంబంధిత పనులు. వీటిని ప్రధానంగా డాష్బోర్డ్ స్వయంగా ఉపయోగిస్తుంది, కానీ ఏదైనా చెల్లుబాటు అయ్యే క్రెడెన్షియల్తో ఇవి పనిచేస్తాయి.
/api/auth/profileBearer సెషన్ టోకెన్ లేదా API కీఆథెంటికేటెడ్ యూజర్ యొక్క ప్రొఫైల్ను తిరిగి ఇస్తుంది.
/api/auth/profileBearer సెషన్ టోకెన్ లేదా API కీడిస్ప్లే పేరు, నోటిఫికేషన్ ప్రాధాన్యతల వంటి ప్రొఫైల్ ఫీల్డ్లను అప్డేట్ చేస్తుంది.
/api/auth/syncBearer సెషన్ టోకెన్Supabase auth యూజర్ను ప్లాట్ఫారమ్ యూజర్ రికార్డ్తో సింక్రొనైజ్ చేస్తుంది.
/api/auth/check-onboardingBearer సెషన్ టోకెన్ఆథెంటికేటెడ్ యూజర్ ఆన్బోర్డింగ్ను పూర్తి చేశారా అని నివేదిస్తుంది.
/api/auth/avatarBearer సెషన్ టోకెన్ఆథెంటికేటెడ్ యూజర్ కోసం ఒక కొత్త అవతార్ ఇమేజ్ను అప్లోడ్ చేస్తుంది.
Client ఎండ్పాయింట్లు
ఒక రోబో యజమాని నిర్వహించే ప్రతిదీ: నమోదు చేసిన రోబోలు, క్లయింట్ ప్రొఫైల్, డేటాసెట్లు, ఇన్వాయిస్లు, డాష్బోర్డ్ గణాంకాలు.
/api/client/robotsBearer సెషన్ టోకెన్ లేదా API కీ (client పాత్ర)ఆథెంటికేటెడ్ క్లయింట్ నమోదు చేసిన రోబోలను, కొత్తది మొదట, 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"
}
]/api/client/robotsBearer సెషన్ టోకెన్ లేదా API కీ (client పాత్ర)ఒక కొత్త రోబోను నమోదు చేసి దాని id ని తిరిగి ఇస్తుంది. ఒక మోటార్ బోర్డ్ హార్డ్వేర్ id ఒకే ఒక రోబోకు మాత్రమే చెందగలదు; ఒక కొలిజన్ 409 స్టేటస్తో తిరస్కరించబడుతుంది.
/api/client/profileBearer సెషన్ టోకెన్ లేదా API కీ (client పాత్ర)ఆథెంటికేటెడ్ యూజర్ యొక్క క్లయింట్ ప్రొఫైల్ను తిరిగి ఇస్తుంది.
/api/client/profileBearer సెషన్ టోకెన్ లేదా API కీ (client పాత్ర)క్లయింట్ ప్రొఫైల్ ఫీల్డ్లను అప్డేట్ చేస్తుంది.
/api/client/datasetsBearer సెషన్ టోకెన్ లేదా API కీ (client పాత్ర)క్లయింట్ యొక్క క్లౌడ్ డేటాసెట్లను ఎపిసోడ్ కౌంట్లు, పరిమాణాలతో జాబితా చేస్తుంది.
/api/client/invoicesBearer సెషన్ టోకెన్ లేదా API కీ (client పాత్ర)క్లయింట్ యొక్క నెలవారీ ఇన్వాయిస్లను జాబితా చేస్తుంది.
/api/client/statsBearer సెషన్ టోకెన్ లేదా API కీ (client పాత్ర)క్లయింట్ డాష్బోర్డ్ కోసం వినియోగ గణాంకాలను తిరిగి ఇస్తుంది.
Operator ఎండ్పాయింట్లు
ఆపరేటర్ వైపు: ప్రొఫైల్, లభ్యత, సర్టిఫికేషన్లు, షెడ్యూలింగ్, ఆదాయ గణాంకాలు.
/api/operator/profileBearer సెషన్ టోకెన్ లేదా API కీ (operator పాత్ర)ఆథెంటికేటెడ్ యూజర్ యొక్క ఆపరేటర్ ప్రొఫైల్ను తిరిగి ఇస్తుంది.
/api/operator/profileBearer సెషన్ టోకెన్ లేదా API కీ (operator పాత్ర)ఆపరేటర్ ప్రొఫైల్ను సృష్టిస్తుంది లేదా అప్డేట్ చేస్తుంది.
/api/operator/available-robotsBearer సెషన్ టోకెన్ లేదా API కీ (operator పాత్ర)ప్రస్తుతం అందుబాటులో ఉన్న, ఆపరేటర్ యొక్క సర్టిఫికేషన్లతో సరిపోలే రోబోలను జాబితా చేస్తుంది.
/api/operator/certificationsBearer సెషన్ టోకెన్ లేదా API కీ (operator పాత్ర)ఆపరేటర్ యొక్క సర్టిఫికేషన్ అభ్యర్థనలను, వాటి స్థితిని జాబితా చేస్తుంది.
/api/operator/certificationsBearer సెషన్ టోకెన్ లేదా API కీ (operator పాత్ర)ఒక రోబో రకం కోసం సర్టిఫికేషన్ను అభ్యర్థిస్తుంది.
/api/operator/scheduleBearer సెషన్ టోకెన్ లేదా API కీ (operator పాత్ర)ఆపరేటర్ యొక్క వారపు లభ్యత షెడ్యూల్ను తిరిగి ఇస్తుంది.
/api/operator/scheduleBearer సెషన్ టోకెన్ లేదా API కీ (operator పాత్ర)వారపు లభ్యత షెడ్యూల్ను అప్డేట్ చేస్తుంది.
/api/operator/availabilityBearer సెషన్ టోకెన్ లేదా API కీ (operator పాత్ర)ఆపరేటర్ యొక్క ప్రస్తుత లభ్యతను తిరిగి ఇస్తుంది.
/api/operator/statsBearer సెషన్ టోకెన్ లేదా API కీ (operator పాత్ర)ఆపరేటర్ డాష్బోర్డ్ కోసం ఆదాయ, సెషన్ గణాంకాలను తిరిగి ఇస్తుంది.
Sessions
సెషన్లు ప్లాట్ఫారమ్ యొక్క ప్రధాన రిసోర్స్: ఒక సెషన్ అంటే ఒక ఆపరేటర్కు, ఒక రోబోకు మధ్య ఒక నిరంతర టెలిఆపరేషన్ నిమగ్నత. సెషన్ స్టేటస్ PENDING, ACTIVE, PAUSED, COMPLETED, CANCELLED ద్వారా కదులుతుంది.
/api/sessionsBearer సెషన్ టోకెన్ లేదా API కీఆథెంటికేటెడ్ యూజర్ కోసం సెషన్లను జాబితా చేస్తుంది. ఆపరేటర్లు తాము ఆపరేట్ చేసిన సెషన్లను చూస్తారు; క్లయింట్లు తమ రోబోలపై ఉన్న సెషన్లను చూస్తారు. రెండు వ్యూల మధ్య ఫీల్డ్ సెట్ కొద్దిగా భిన్నంగా ఉంటుంది: క్లయింట్ వ్యూలో episodes_collected, data_collected_mb ఉంటాయి, ఆపరేటర్ వ్యూలో operator_earnings_cents ఉంటుంది.
| Name | In | Type | Description |
|---|---|---|---|
| status | query | string | ఐచ్ఛికం. ACTIVE లేదా COMPLETED వంటి సెషన్ స్టేటస్ ద్వారా ఫిల్టర్ చేయండి. అన్నింటినీ జాబితా చేయడానికి వదిలేయండి. |
| limit | query | number | ఐచ్ఛికం. పేజ్ పరిమాణం, డిఫాల్ట్ 50, గరిష్టం 100. |
| offset | query | number | ఐచ్ఛికం. పేజినేషన్ ఆఫ్సెట్, డిఫాల్ట్ 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 సెషన్ టోకెన్ లేదా API కీ (operator పాత్ర)ఒక అందుబాటులో ఉన్న రోబోపై ఒక టెలిఆపరేషన్ సెషన్ను ప్రారంభిస్తుంది. దీనికి operator పాత్ర అవసరం: క్లయింట్లు సెషన్లను ప్రారంభించలేరు. ఒక ఆపరేటర్ ఒక సమయంలో ఎక్కువగా ఒక ACTIVE లేదా PAUSED సెషన్ను మాత్రమే కలిగి ఉండగలరు, రోబో స్టేటస్ ప్రస్తుతం AVAILABLE గా ఉండాలి. వెంటనే ప్రారంభమైతే రోబో IN_SESSION కు మారుతుంది, క్లయింట్కు తెలియజేయబడుతుంది.
| Name | In | Type | Description |
|---|---|---|---|
| robotId | body | string | అవసరం. ఆపరేట్ చేయాల్సిన రోబో యొక్క id. రోబో AVAILABLE గా ఉండాలి. |
| operatorId | body | string | ఐచ్ఛికం. స్పష్టమైన ఆపరేటర్ id; డిఫాల్ట్గా ఆథెంటికేటెడ్ ఆపరేటర్. |
| scheduledFor | body | string (ISO 8601) | ఐచ్ఛికం. సెషన్ను వెంటనే ప్రారంభించడానికి బదులు భవిష్యత్ సమయానికి షెడ్యూల్ చేస్తుంది. |
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 సెషన్ టోకెన్ లేదా API కీదాని వివరాలతో ఒక సింగిల్ సెషన్ను తిరిగి ఇస్తుంది.
/api/sessions/[id]Bearer సెషన్ టోకెన్ లేదా API కీసెషన్ లైఫ్సైకిల్ను అప్డేట్ చేస్తుంది: pause, resume, end, సంబంధిత చర్యలు.
/api/sessions/[id]/extendBearer సెషన్ టోకెన్ లేదా API కీ (client, సెషన్ యజమాని)ఒక సెషన్ ఎక్స్టెన్షన్ను అభ్యర్థిస్తుంది. సెషన్ను సొంతం చేసుకున్న క్లయింట్ మాత్రమే దీన్ని కాల్ చేయగలరు, సెషన్ ACTIVE గా ఉండాలి. అభ్యర్థన ఒక సెషన్ ఈవెంట్గా లాగ్ చేయబడుతుంది, ఆపరేటర్కు ఒక నోటిఫికేషన్ లభిస్తుంది; ఆపరేటర్ దానిపై చర్య తీసుకున్నప్పుడు అసలైన ఎక్స్టెన్షన్ జరుగుతుంది.
| Name | In | Type | Description |
|---|---|---|---|
| id | path | string | సెషన్ id. |
| additionalMinutes | body | number | అభ్యర్థించిన ఎక్స్టెన్షన్ పొడవు, నిమిషాల్లో. |
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 సెషన్ టోకెన్ లేదా API కీఒక సెషన్ యొక్క చాట్ మెసేజ్లను జాబితా చేస్తుంది.
/api/sessions/[id]/messagesBearer సెషన్ టోకెన్ లేదా API కీఒక సెషన్లో ఒక చాట్ మెసేజ్ను పంపుతుంది.
/api/sessions/[id]/rateBearer సెషన్ టోకెన్ లేదా API కీ (client)ఒక పూర్తయిన సెషన్ను 1 నుండి 5 స్టార్ స్కేల్పై రేట్ చేస్తుంది, ఐచ్ఛిక వ్యాఖ్యతో.
/api/sessions/exportBearer సెషన్ టోకెన్ లేదా API కీసెషన్ డేటాను ఎగుమతి చేస్తుంది.
Payments
అన్ని డబ్బు కదలికలు Stripe ద్వారా జరుగుతాయి. క్లయింట్ బిల్లింగ్ సేవ్ చేసిన చెల్లింపు పద్ధతితో ఒక Stripe కస్టమర్ను ఉపయోగిస్తుంది; ఆపరేటర్ పేఅవుట్లు Stripe Connect ను ఉపయోగిస్తాయి. ప్లాట్ఫారమ్ స్వయంగా ఎప్పుడూ కార్డ్ లేదా బ్యాంక్ డేటాను నిల్వ చేయదు.
/api/stripe/customerBearer సెషన్ టోకెన్ (client పాత్ర)క్లయింట్ బిల్లింగ్ కోసం ఉపయోగించే Stripe కస్టమర్ను సృష్టిస్తుంది లేదా తిరిగి ఇస్తుంది.
/api/stripe/connectBearer సెషన్ టోకెన్ (operator పాత్ర)ఆపరేటర్ యొక్క Stripe Connect ఖాతా స్థితిని తిరిగి ఇస్తుంది.
/api/stripe/connectBearer సెషన్ టోకెన్ (operator పాత్ర)ఆపరేటర్ పేఅవుట్ల కోసం Stripe Connect ఆన్బోర్డింగ్ను ప్రారంభిస్తుంది.
/api/stripe/setup-intentBearer సెషన్ టోకెన్ (client పాత్ర)ఒక చెల్లింపు పద్ధతిని సేవ్ చేయడానికి ఒక Stripe SetupIntent ను సృష్టిస్తుంది.
/api/stripe/portalBearer సెషన్ టోకెన్ (client పాత్ర)చెల్లింపు పద్ధతులను, ఇన్వాయిస్లను నిర్వహించడానికి ఒక Stripe బిల్లింగ్ పోర్టల్ సెషన్ను సృష్టిస్తుంది.
/api/stripe/payoutBearer సెషన్ టోకెన్ (operator పాత్ర)ఆథెంటికేటెడ్ ఆపరేటర్ కోసం పేఅవుట్ సమాచారాన్ని తిరిగి ఇస్తుంది.
/api/stripe/payoutBearer సెషన్ టోకెన్ (operator పాత్ర)పోగుపడిన ఆదాయాల పేఅవుట్ను అభ్యర్థిస్తుంది. కనీస పేఅవుట్ 10.00 EUR.
/api/stripe/webhookStripe వెబ్హుక్ సిగ్నేచర్Stripe వెబ్హుక్ ఈవెంట్లను స్వీకరిస్తుంది. API క్లయింట్లచే కాకుండా, Stripe చే కాల్ చేయబడుతుంది.
Public ఎండ్పాయింట్లు
ఈ ఎండ్పాయింట్లకు ఎలాంటి ఆథెంటికేషన్ అవసరం లేదు. మానిటరింగ్, మార్కెటింగ్ పేజీలు, లేదా ఒక స్టేటస్ ప్రోబ్ నుండి కాల్ చేయడం సురక్షితం.
/api/healthAPI కు, దాని డేటాబేస్ కనెక్షన్కు హెల్త్ చెక్. రెండూ బాగుంటే 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"
}/api/robots/[id]ఒక మద్దతు ఉన్న రోబో మోడల్ గురించి పబ్లిక్ సమాచారాన్ని తిరిగి ఇస్తుంది.
/api/public/pricingప్రస్తుత పబ్లిక్ ధర ప్లాన్లను తిరిగి ఇస్తుంది.
/api/contactఒక కాంటాక్ట్ ఫారం మెసేజ్ను సమర్పిస్తుంది. మెసేజ్ ముందుగా నిల్వ చేయబడి తర్వాత ఇమెయిల్ ద్వారా డెలివర్ చేయబడుతుంది, కాబట్టి ఒక తాత్కాలిక మెయిల్ అంతరాయం దాన్ని కోల్పోదు: ఆ పరిస్థితిలో రెస్పాన్స్ stored true, delivered false అని నివేదిస్తుంది, డెలివరీ ఆపరేషనల్గా మళ్లీ ప్రయత్నించబడుతుంది.
| Name | In | Type | Description |
|---|---|---|---|
| name | body | string | అవసరం. మీ పేరు. |
| body | string | అవసరం. రిప్లై కోసం ఒక చెల్లుబాటు అయ్యే ఇమెయిల్ చిరునామా. | |
| category | body | string | అవసరం. వీటిలో ఒకటి: General Inquiry, Bug Report, Feature Request, Sales & Pricing, Partnership, Career/Jobs, Technical Support, Billing & Payments, Press & Media, Other. |
| subject | body | string | అవసరం. ఒక చిన్న సబ్జెక్ట్ లైన్. |
| message | body | string | అవసరం. మెసేజ్ బాడీ. |
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-requestప్లాట్ఫారమ్పై ఇంకా లేని ఒక రోబో రకం కోసం మద్దతును అభ్యర్థిస్తుంది.
/api/statsపబ్లిక్ ప్లాట్ఫారమ్ గణాంకాలను తిరిగి ఇస్తుంది.
AY-Robots ఖాతాలను, లైవ్ రోబో నియంత్రణను ఎలా భద్రపరుస్తుంది: Supabase ఆథెంటికేషన్, పాత్ర మోడల్, API కీలు, సెషన్ సేఫ్గార్డ్లు, ఆడిట్ ట్రెయిల్, ఎన్క్రిప్షన్.
AY-Robots సెషన్లు ఎలా పనిచేస్తాయి: PENDING నుండి COMPLETED వరకు లైఫ్సైకిల్, ప్రతి యాక్టివిటీ ఈవెంట్ వివరించబడింది, సెషన్ చాట్, రేటింగ్లు, ఎక్స్టెన్షన్లు, ట్రైనింగ్ డేటా.