1. PocketHook इंस्टॉल करें#
App Store से PocketHook डाउनलोड करें और इसे अपने iPhone, iPad या Mac पर खोलें।
2. अपना सर्वर कॉन्फ़िगर करें#
PocketHook को संचार के लिए एक HTTPS endpoint की आवश्यकता है। आप उपयोग कर सकते हैं:
- Agent Server — LLM, टूल्स, बैकग्राउंड जॉब्स और मेमोरी के साथ सेल्फ-होस्टेड AI एजेंट
- आपका अपना API — कोई भी सर्वर जो POST अनुरोध स्वीकार करता है और JSON लौटाता है
- n8n — webhook ट्रिगर के साथ सेल्फ-होस्टेड वर्कफ़्लो ऑटोमेशन
- OpenClaw — मल्टी-चैनल मैसेजिंग के साथ सेल्फ-होस्टेड AI सहायक
सर्वर आवश्यकताएँ#
आपके सर्वर को:
- JSON बॉडी के साथ POST अनुरोध स्वीकार करने चाहिए
- JSON रिस्पॉन्स लौटाने चाहिए
- HTTPS के माध्यम से एक्सेस योग्य होना चाहिए (सुरक्षा के लिए HTTP अस्वीकार किया जाता है)
- वैकल्पिक रूप से Bearer token प्रमाणीकरण का समर्थन करना चाहिए
3. PocketHook में कनेक्ट करें#
- PocketHook खोलें और सेटिंग्स पर जाएँ
- अपना सर्वर URL दर्ज करें (HTTPS होना चाहिए)
- अपना Auth Token दर्ज करें (यदि आपके सर्वर को प्रमाणीकरण की आवश्यकता है)
- सत्यापित करने के लिए कनेक्शन टेस्ट करें पर टैप करें
4. अनुरोध प्रारूप#
PocketHook संदेशों को JSON ऐरे के रूप में भेजता है:
[{
"sessionId": "uuid-v4",
"action": "sendMessage",
"chatInput": "आपका संदेश यहाँ"
}]
5. रिस्पॉन्स प्रारूप#
आपके सर्वर को JSON ऑब्जेक्ट के साथ रिस्पॉन्ड करना चाहिए:
{
"msg": "उपयोगकर्ता को दिखाया गया संदेश",
"shortcut": "वैकल्पिकशॉर्टकटनाम",
"data": { "कुंजी": "मान" },
"url": "https://optional-url.com"
}
| फ़ील्ड | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
msg | string | हाँ | चैट में प्रदर्शित टेक्स्ट |
shortcut | string | नहीं | निष्पादित करने के लिए iOS Shortcut |
data | object | array | नहीं | Shortcut को पास किया गया डेटा |
url | string | नहीं | खोलने या प्रदर्शित करने के लिए URL |
मल्टी-स्टेप ऑटोमेशन के लिए, रिस्पॉन्स का ऐरे लौटाएँ:
[
{ "msg": "चरण 1...", "shortcut": "पहलाशॉर्टकट" },
{ "msg": "चरण 2...", "shortcut": "दूसराशॉर्टकट", "data": { "input": "मान" } }
]
6. Starter सर्वर के साथ क्विक स्टार्ट#
मिनटों में शुरू करने के लिए हमारे starter सर्वर टेम्पलेट का उपयोग करें:
git clone https://github.com/pockethook-app/pockethook-server.git
cd pockethook-server
bun install
cp .env.example .env
# .env को अपने सीक्रेट टोकन से संपादित करें
bun dev
Starter में बिल्ट-इन कमांड (ping, hello, help, time) और Shortcuts ट्रिगर करने के उदाहरण शामिल हैं। पूर्ण प्रोटोकॉल स्पेसिफिकेशन के लिए API रेफरेंस देखें।
7. SDK का उपयोग#
टाइप-सेफ रिस्पॉन्स बनाने के लिए pockethook-sdk पैकेज इंस्टॉल करें:
bun add pockethook-sdk
import { text, shortcut, responses, toResponse } from "pockethook-sdk";
// सरल टेक्स्ट रिस्पॉन्स
return toResponse(text("मेरे सर्वर से नमस्ते!"));
// Shortcut ट्रिगर करें
return toResponse(shortcut("चल रहा है...", "मेराशॉर्टकट", { कुंजी: "मान" }));
// मल्टी-स्टेप ऑटोमेशन
return toResponse(responses([
{ msg: "चरण 1", shortcut: "पहला" },
{ msg: "चरण 2", shortcut: "दूसरा" }
]));