मुख्य सामग्री पर जाएं
ResQ दो HTTPS APIs उजागर करता है:
APIबेस URLस्टैक
Infrastructure APIhttps://api.resq.softwareRust + Axum
Coordination APIhttps://coordination.resq.softwareTypeScript + Elysia
यदि आप स्व-होस्टेड डिप्लॉयमेंट चला रहे हैं, ऊपर के बेस URLs को अपने URLs से बदलें। अनुरोध आकार समान हैं।

​
चरण

1

पुष्टि करें कि सेवा चल रही है

Infrastructure API के /health पर कॉल करें। प्रमाणीकरण की आवश्यकता नहीं।
curl https://api.resq.software/health
एक स्वस्थ प्रतिक्रिया इस तरह दिखती है:
{
  "status": "ok",
  "pinata": true,
  "gemini": true,
  "spoon_os": "0.1.0"
}
2

JWT प्राप्त करें

Infrastructure API bearer JWT उपयोग करता है। POST /login पर क्रेडेंशियल को टोकन से बदलें।
curl -X POST https://api.resq.software/login \
  -H "Content-Type: application/json" \
  -d '{"username":"आपका-यूज़रनेम","password":"आपका-पासवर्ड"}'
प्रतिक्रिया में टोकन और Unix एक्सपायरी होती है:
{
  "token": "eyJhbGciOi...",
  "expires_at": 1746345600
}
टोकन सुरक्षित रूप से संग्रहीत करें। रिफ़्रेश और रोटेशन के लिए प्रमाणीकरण देखें।
3

प्रमाणित एंडपॉइंट कॉल करें

टोकन को Bearer हेडर के रूप में भेजें।
curl https://api.resq.software/evidence \
  -H "Authorization: Bearer $RESQ_TOKEN"
4

Coordination API से टेलीमेट्री स्ट्रीम करें

Coordination API रीयल-टाइम फ़्लीट स्टेट के लिए Prometheus मेट्रिक्स और Server-Sent Events उजागर करता है।
curl -N https://coordination.resq.software/events
प्रत्येक पंक्ति एक JSON इवेंट है: टेलीमेट्री फ़्रेम, मिशन स्टेट परिवर्तन, और HITL अनुमोदन।
5

एक SDK चुनें

क्लाइंट लिखने से बचें — एक आधिकारिक SDK स्थापित करें।

TypeScript

@resq-sw/http, @resq-sw/security, UI कंपोनेंट।

Python

resq-mcp (FastMCP सर्वर) और resq-dsa।

Rust

एकीकृत resq CLI और सात TUI टूल।

.NET

टाइप किए गए क्लाइंट, Protobuf कॉन्ट्रैक्ट, सिम हार्नेस।

​
अगला

प्रमाणीकरण

JWT जीवनचक्र और रोटेशन।

त्रुटियाँ

एरर एनवेलप और स्टेटस कोड।

API संदर्भ

सभी एंडपॉइंट, अनुरोध, और प्रतिक्रियाएं।