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, உலாவி உள்நுழைவைச் சார்ந்திருக்கக்கூடாத எதுவும்
MCPhttps://www.ay-robots.com/api/mcp இல் ஹோஸ்ட் செய்யப்பட்ட MCP சர்வர் (Streamable HTTP)Model Context Protocol பேசும் LLM ஏஜென்ட்கள் மற்றும் டூல்கள்
bash
curl https://www.ay-robots.com/api/sessions \
  -H 'Authorization: Bearer ayr_live_your_key_here'
ஒரு API கீயுடன் ஆதன்டிகேட் செய்தல்

API கீக்கள் /dashboard/settings இல் உருவாக்கப்பட்டு ரத்து செய்யப்படுகின்றன. அவற்றை கடவுச்சொற்கள் போல நடத்துங்கள்: அவற்றை சர்வர்-பக்கத்தில் வையுங்கள், பழையதை ரத்து செய்வதற்கு முன் ஒரு மாற்று கீயை உருவாக்கி ரொட்டேட் செய்யுங்கள். நீங்கள் டெஸ்க்டாப் CLI ஐப் பயன்படுத்தினால், அது ay-robots mcp என்ற கட்டளையுடன் தளத்தை ஒரு உள்ளூர் MCP சர்வராகவும் காட்ட முடியும்.

ரெஸ்பான்ஸ்கள் JSON. பிழைகள் ஒரு சீரான வடிவத்தில் இருக்கும்: ஒரு மனிதனால் படிக்கக்கூடிய செய்தியைக் கொண்ட ஒரு error ஃபீல்டுடன் ஒரு JSON ஆப்ஜெக்ட், பொருத்தமான 4xx அல்லது 5xx ஸ்டேட்டஸ் கோடுடன் வழங்கப்படும். வெற்றிகரமான ரெஸ்பான்ஸ்கள் ரிசோர்ஸை நேரடியாகத் திருப்பும்; சில எண்ட்பாயிண்ட்கள் பட்டியல்களை பெயரிடப்பட்ட ஒரு ஃபீல்டில் மடிக்கின்றன, இது முக்கியமான இடங்களில் கீழே உள்ள உதாரணங்கள் காட்டுகின்றன.

Auth எண்ட்பாயிண்ட்கள்

கணக்கு மற்றும் ப்ரொஃபைல் தொடர்பான வேலைகள். இவை முதன்மையாக டாஷ்போர்டு தானே பயன்படுத்துகிறது, ஆனால் எந்த செல்லுபடியான நற்சான்றிதழுடனும் அவை வேலை செய்கின்றன.

GET/api/auth/profileBearer செஷன் டோக்கன் அல்லது API கீ

ஆதன்டிகேட் செய்யப்பட்ட பயனரின் ப்ரொஃபைலைத் திருப்புகிறது.

POST/api/auth/profileBearer செஷன் டோக்கன் அல்லது API கீ

காட்சிப் பெயர் மற்றும் அறிவிப்பு விருப்பங்கள் போன்ற ப்ரொஃபைல் ஃபீல்டுகளைப் புதுப்பிக்கிறது.

POST/api/auth/syncBearer செஷன் டோக்கன்

Supabase auth பயனரை தள பயனர் பதிவுடன் ஒத்திசைக்கிறது.

GET/api/auth/check-onboardingBearer செஷன் டோக்கன்

ஆதன்டிகேட் செய்யப்பட்ட பயனர் ஆன்போர்டிங்கை முடித்துவிட்டாரா என்பதை அறிக்கை செய்கிறது.

POST/api/auth/avatarBearer செஷன் டோக்கன்

ஆதன்டிகேட் செய்யப்பட்ட பயனருக்கு ஒரு புதிய அவதார படத்தை அப்லோட் செய்கிறது.

Client எண்ட்பாயிண்ட்கள்

ஒரு ரோபோ உரிமையாளர் நிர்வகிக்கும் அனைத்தும்: பதிவு செய்யப்பட்ட ரோபோக்கள், கிளையன்ட் ப்ரொஃபைல், டேட்டாசெட்கள், இன்வாய்ஸ்கள், டாஷ்போர்டு புள்ளிவிவரங்கள்.

GET/api/client/robotsBearer செஷன் டோக்கன் அல்லது API கீ (client பாத்திரம்)

ஆதன்டிகேட் செய்யப்பட்ட கிளையன்ட் பதிவு செய்த ரோபோக்களை, புதியது முதலில், 50 உள்ளீடுகள் வரை பட்டியலிடுகிறது. டைம்ஸ்டாம்ப்கள் ISO 8601; ரோபோ ஒருமுறை இணைந்த பிறகுதான் last_online மற்றும் last_heartbeat null அல்லாமல் இருக்கும்.

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 செஷன் டோக்கன் அல்லது API கீ (client பாத்திரம்)

ஒரு புதிய ரோபோவைப் பதிவு செய்து அதன் id ஐத் திருப்புகிறது. ஒரு மோட்டார் போர்டு ஹார்ட்வேர் id ஒரே ஒரு ரோபோவுக்கு மட்டுமே சொந்தமாக இருக்க முடியும்; ஒரு மோதல் 409 ஸ்டேட்டஸுடன் நிராகரிக்கப்படும்.

GET/api/client/profileBearer செஷன் டோக்கன் அல்லது API கீ (client பாத்திரம்)

ஆதன்டிகேட் செய்யப்பட்ட பயனரின் கிளையன்ட் ப்ரொஃபைலைத் திருப்புகிறது.

PATCH/api/client/profileBearer செஷன் டோக்கன் அல்லது API கீ (client பாத்திரம்)

கிளையன்ட் ப்ரொஃபைல் ஃபீல்டுகளைப் புதுப்பிக்கிறது.

GET/api/client/datasetsBearer செஷன் டோக்கன் அல்லது API கீ (client பாத்திரம்)

கிளையன்டின் கிளவுட் டேட்டாசெட்களை எபிசோட் எண்ணிக்கைகள் மற்றும் அளவுகளுடன் பட்டியலிடுகிறது.

GET/api/client/invoicesBearer செஷன் டோக்கன் அல்லது API கீ (client பாத்திரம்)

கிளையன்டின் மாதாந்திர இன்வாய்ஸ்களைப் பட்டியலிடுகிறது.

GET/api/client/statsBearer செஷன் டோக்கன் அல்லது API கீ (client பாத்திரம்)

கிளையன்ட் டாஷ்போர்டுக்கான பயன்பாட்டு புள்ளிவிவரங்களைத் திருப்புகிறது.

Operator எண்ட்பாயிண்ட்கள்

ஆபரேட்டர் பக்கம்: ப்ரொஃபைல் மற்றும் கிடைக்கும் தன்மை, சான்றிதழ்கள், அட்டவணையிடல், வருமான புள்ளிவிவரங்கள்.

GET/api/operator/profileBearer செஷன் டோக்கன் அல்லது API கீ (operator பாத்திரம்)

ஆதன்டிகேட் செய்யப்பட்ட பயனரின் ஆபரேட்டர் ப்ரொஃபைலைத் திருப்புகிறது.

POST/api/operator/profileBearer செஷன் டோக்கன் அல்லது API கீ (operator பாத்திரம்)

ஆபரேட்டர் ப்ரொஃபைலை உருவாக்குகிறது அல்லது புதுப்பிக்கிறது.

GET/api/operator/available-robotsBearer செஷன் டோக்கன் அல்லது API கீ (operator பாத்திரம்)

தற்போது கிடைக்கும், ஆபரேட்டரின் சான்றிதழ்களுடன் பொருந்தும் ரோபோக்களைப் பட்டியலிடுகிறது.

GET/api/operator/certificationsBearer செஷன் டோக்கன் அல்லது API கீ (operator பாத்திரம்)

ஆபரேட்டரின் சான்றிதழ் கோரிக்கைகளையும் அவற்றின் நிலையையும் பட்டியலிடுகிறது.

POST/api/operator/certificationsBearer செஷன் டோக்கன் அல்லது API கீ (operator பாத்திரம்)

ஒரு ரோபோ வகைக்கான சான்றிதழைக் கோருகிறது.

GET/api/operator/scheduleBearer செஷன் டோக்கன் அல்லது API கீ (operator பாத்திரம்)

ஆபரேட்டரின் வாராந்திர கிடைக்கும் தன்மை அட்டவணையைத் திருப்புகிறது.

POST/api/operator/scheduleBearer செஷன் டோக்கன் அல்லது API கீ (operator பாத்திரம்)

வாராந்திர கிடைக்கும் தன்மை அட்டவணையைப் புதுப்பிக்கிறது.

GET/api/operator/availabilityBearer செஷன் டோக்கன் அல்லது API கீ (operator பாத்திரம்)

ஆபரேட்டரின் தற்போதைய கிடைக்கும் தன்மையைத் திருப்புகிறது.

GET/api/operator/statsBearer செஷன் டோக்கன் அல்லது API கீ (operator பாத்திரம்)

ஆபரேட்டர் டாஷ்போர்டுக்கான வருமானம் மற்றும் செஷன் புள்ளிவிவரங்களைத் திருப்புகிறது.

Sessions

செஷன்கள் தளத்தின் மைய ரிசோர்ஸ்: ஒரு செஷன் என்பது ஒரு ஆபரேட்டருக்கும் ஒரு ரோபோவுக்கும் இடையிலான ஒரு தொடர்ச்சியான டெலிஆபரேஷன் ஈடுபாடு. செஷன் ஸ்டேட்டஸ் PENDING, ACTIVE, PAUSED, COMPLETED, CANCELLED வழியாக நகர்கிறது.

GET/api/sessionsBearer செஷன் டோக்கன் அல்லது API கீ

ஆதன்டிகேட் செய்யப்பட்ட பயனருக்கான செஷன்களைப் பட்டியலிடுகிறது. ஆபரேட்டர்கள் தாங்கள் இயக்கிய செஷன்களைப் பார்க்கிறார்கள்; கிளையன்ட்கள் தங்கள் ரோபோக்களில் உள்ள செஷன்களைப் பார்க்கிறார்கள். இரு காட்சிகளுக்கும் இடையே ஃபீல்ட் தொகுப்பு சற்று வேறுபடுகிறது: கிளையன்ட் காட்சியில் episodes_collected மற்றும் data_collected_mb அடங்கும், ஆபரேட்டர் காட்சியில் operator_earnings_cents அடங்கும்.

NameInTypeDescription
statusquerystringஐச்சிகம். ACTIVE அல்லது COMPLETED போன்ற செஷன் ஸ்டேட்டஸால் வடிகட்டவும். அனைத்தையும் பட்டியலிட விடவும்.
limitquerynumberஐச்சிகம். பக்க அளவு, இயல்பு 50, அதிகபட்சம் 100.
offsetquerynumberஐச்சிகம். பேஜினேஷன் ஆஃப்செட், இயல்பு 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 செஷன் டோக்கன் அல்லது API கீ (operator பாத்திரம்)

ஒரு கிடைக்கும் ரோபோவில் ஒரு டெலிஆபரேஷன் செஷனைத் தொடங்குகிறது. operator பாத்திரம் தேவை: கிளையன்ட்கள் செஷன்களைத் தொடங்க முடியாது. ஒரு ஆபரேட்டர் ஒரு நேரத்தில் அதிகபட்சம் ஒரு ACTIVE அல்லது PAUSED செஷனை மட்டுமே வைத்திருக்க முடியும், ரோபோவின் ஸ்டேட்டஸ் தற்போது AVAILABLE ஆக இருக்க வேண்டும். உடனடி தொடக்கத்தில் ரோபோ IN_SESSION க்கு மாறுகிறது, கிளையன்டுக்கு அறிவிக்கப்படுகிறது.

NameInTypeDescription
robotIdbodystringஅவசியம். இயக்க வேண்டிய ரோபோவின் id. ரோபோ AVAILABLE ஆக இருக்க வேண்டும்.
operatorIdbodystringஐச்சிகம். தெளிவான ஆபரேட்டர் id; இயல்புநிலை ஆதன்டிகேட் செய்யப்பட்ட ஆபரேட்டர்.
scheduledForbodystring (ISO 8601)ஐச்சிகம். செஷனை உடனடியாக தொடங்குவதற்குப் பதிலாக எதிர்கால நேரத்திற்கு அட்டவணைப்படுத்துகிறது.
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 செஷன் டோக்கன் அல்லது API கீ

அதன் விவரங்களுடன் ஒரு ஒற்றை செஷனைத் திருப்புகிறது.

PATCH/api/sessions/[id]Bearer செஷன் டோக்கன் அல்லது API கீ

செஷன் வாழ்க்கைச் சுழற்சியைப் புதுப்பிக்கிறது: pause, resume, end, தொடர்புடைய செயல்கள்.

POST/api/sessions/[id]/extendBearer செஷன் டோக்கன் அல்லது API கீ (client, செஷன் உரிமையாளர்)

ஒரு செஷன் நீட்டிப்பைக் கோருகிறது. செஷனை சொந்தமாக வைத்திருக்கும் கிளையன்ட் மட்டுமே இதை அழைக்க முடியும், செஷன் ACTIVE ஆக இருக்க வேண்டும். கோரிக்கை ஒரு செஷன் நிகழ்வாகப் பதிவு செய்யப்படுகிறது, ஆபரேட்டர் ஒரு அறிவிப்பைப் பெறுகிறார்; ஆபரேட்டர் அதன் மீது நடவடிக்கை எடுக்கும்போது உண்மையான நீட்டிப்பு நடக்கிறது.

NameInTypeDescription
idpathstringசெஷன் id.
additionalMinutesbodynumberகோரப்பட்ட நீட்டிப்பு நீளம், நிமிடங்களில்.
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 செஷன் டோக்கன் அல்லது API கீ

ஒரு செஷனின் சாட் செய்திகளைப் பட்டியலிடுகிறது.

POST/api/sessions/[id]/messagesBearer செஷன் டோக்கன் அல்லது API கீ

ஒரு செஷனில் ஒரு சாட் செய்தியை அனுப்புகிறது.

POST/api/sessions/[id]/rateBearer செஷன் டோக்கன் அல்லது API கீ (client)

ஒரு முடிக்கப்பட்ட செஷனை 1 முதல் 5 நட்சத்திரங்கள் அளவில் மதிப்பிடுகிறது, ஐச்சிக கருத்துடன்.

POST/api/sessions/exportBearer செஷன் டோக்கன் அல்லது API கீ

செஷன் டேட்டாவை ஏற்றுமதி செய்கிறது.

Payments

அனைத்து பண இயக்கமும் Stripe வழியாக நடக்கிறது. கிளையன்ட் பில்லிங் ஒரு சேமித்த கட்டண முறையுடன் ஒரு Stripe கஸ்டமரைப் பயன்படுத்துகிறது; ஆபரேட்டர் பேஅவுட்கள் Stripe Connect ஐப் பயன்படுத்துகின்றன. தளமே ஒருபோதும் கார்டு அல்லது வங்கி டேட்டாவை சேமிக்காது.

POST/api/stripe/customerBearer செஷன் டோக்கன் (client பாத்திரம்)

கிளையன்ட் பில்லிங்கிற்குப் பயன்படுத்தப்படும் Stripe கஸ்டமரை உருவாக்குகிறது அல்லது திருப்புகிறது.

GET/api/stripe/connectBearer செஷன் டோக்கன் (operator பாத்திரம்)

ஆபரேட்டரின் Stripe Connect கணக்கின் நிலையைத் திருப்புகிறது.

POST/api/stripe/connectBearer செஷன் டோக்கன் (operator பாத்திரம்)

ஆபரேட்டர் பேஅவுட்களுக்கான Stripe Connect ஆன்போர்டிங்கைத் தொடங்குகிறது.

POST/api/stripe/setup-intentBearer செஷன் டோக்கன் (client பாத்திரம்)

ஒரு கட்டண முறையை சேமிப்பதற்கான ஒரு Stripe SetupIntent ஐ உருவாக்குகிறது.

POST/api/stripe/portalBearer செஷன் டோக்கன் (client பாத்திரம்)

கட்டண முறைகள் மற்றும் இன்வாய்ஸ்களை நிர்வகிக்க ஒரு Stripe பில்லிங் போர்டல் செஷனை உருவாக்குகிறது.

GET/api/stripe/payoutBearer செஷன் டோக்கன் (operator பாத்திரம்)

ஆதன்டிகேட் செய்யப்பட்ட ஆபரேட்டருக்கான பேஅவுட் தகவலைத் திருப்புகிறது.

POST/api/stripe/payoutBearer செஷன் டோக்கன் (operator பாத்திரம்)

திரண்ட வருமானத்தின் பேஅவுட்டைக் கோருகிறது. குறைந்தபட்ச பேஅவுட் 10.00 EUR.

POST/api/stripe/webhookStripe வெப்ஹூக் சிக்னேச்சர்

Stripe வெப்ஹூக் நிகழ்வுகளைப் பெறுகிறது. API கிளையன்ட்களால் அல்ல, Stripe ஆல் அழைக்கப்படுகிறது.

Public எண்ட்பாயிண்ட்கள்

இந்த எண்ட்பாயிண்ட்களுக்கு ஆதன்டிகேஷன் தேவையில்லை. மானிடரிங், மார்க்கெட்டிங் பக்கங்கள், அல்லது ஒரு ஸ்டேட்டஸ் ப்ரோப் ஆகியவற்றிலிருந்து அழைப்பது பாதுகாப்பானது.

GET/api/health

API மற்றும் அதன் டேட்டாபேஸ் இணைப்பிற்கான ஹெல்த் செக். இரண்டும் நன்றாக இருந்தால் 200 ஐத் திருப்புகிறது; டேட்டாபேஸ் செக் தோல்வியடைந்தால், அதே வடிவம் status மற்றும் db ஐ error ஆக அமைத்து HTTP ஸ்டேட்டஸ் 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]

ஒரு ஆதரிக்கப்படும் ரோபோ மாடலைப் பற்றிய பொது தகவலைத் திருப்புகிறது.

GET/api/public/pricing

தற்போதைய பொது விலை திட்டங்களைத் திருப்புகிறது.

POST/api/contact

ஒரு தொடர்பு படிவ செய்தியைச் சமர்ப்பிக்கிறது. செய்தி முதலில் சேமிக்கப்பட்டு பின்னர் மின்னஞ்சல் மூலம் வழங்கப்படுகிறது, எனவே ஒரு தற்காலிக மெயில் தடங்கல் அதை இழக்காது: அந்த நிலையில் ரெஸ்பான்ஸ் stored true, delivered false என்று அறிக்கை செய்கிறது, வழங்குதல் செயல்பாட்டு ரீதியாக மீண்டும் முயற்சிக்கப்படும்.

NameInTypeDescription
namebodystringஅவசியம். உங்கள் பெயர்.
emailbodystringஅவசியம். பதிலுக்கான ஒரு செல்லுபடியான மின்னஞ்சல் முகவரி.
categorybodystringஅவசியம். இவற்றில் ஒன்று: General Inquiry, Bug Report, Feature Request, Sales & Pricing, Partnership, Career/Jobs, Technical Support, Billing & Payments, Press & Media, Other.
subjectbodystringஅவசியம். ஒரு குறுகிய தலைப்பு வரி.
messagebodystringஅவசியம். செய்தியின் முக்கிய பகுதி.
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

தளத்தில் இன்னும் இல்லாத ஒரு ரோபோ வகைக்கான ஆதரவைக் கோருகிறது.

GET/api/stats

பொது தள புள்ளிவிவரங்களைத் திருப்புகிறது.