REST API

अपनी Skimle परियोजनाओं पर निर्माण करें

परियोजना डेटा पढ़ने और लिखने, और किसी परियोजना को शुरू से अंत तक चलाने के लिए JSON एंडपॉइंट। Bearer कुंजी से प्रमाणीकरण करें, एक action भेजें, JSON वापस पाएँ।

तीन चरणों में शुरू करें

शून्य से आपकी पहली प्रमाणित कॉल तक।

1

API कुंजी बनाएँ

परियोजना कुंजी एक परियोजना तक पहुँचती है। खाता कुंजी एक टीम तक पहुँचती है और उसमें परियोजनाएँ बना सकती है। दोनों पढ़ने और संपादन स्तरों में आती हैं।

  1. 1. API कुंजी पेज खोलें
  2. 2. वह परियोजना चुनें जिस तक कुंजी पहुँचेगी और पढ़ने या संपादन की अनुमति चुनें
  3. 3. कुंजी कॉपी करें, Skimle केवल उसका हैश संग्रहीत करता है

कुंजी तुरंत कॉपी करें।

पूरी कुंजी केवल बनाते समय एक बार दिखाई जाती है। डायलॉग बंद करने के बाद हमारे पास केवल हैश रहता है, खोई हुई कुंजी दोबारा जारी करनी पड़ती है।

2

अपना पहला अनुरोध भेजें

कुंजी को Bearer टोकन के रूप में और action को JSON बॉडी में भेजें। हर एंडपॉइंट JSON लेता और JSON लौटाता है।

curl -X POST https://app.skimle.com/api/skimle-read \
  -H "Authorization: Bearer skm_…r" \
  -H "Content-Type: application/json" \
  -d '{ "action": "get_categories" }'

पढ़ने की कुंजियाँ r पर और संपादन कुंजियाँ e पर समाप्त होती हैं। परियोजना कुंजियाँ /api/skimle-read और /api/skimle-write को कॉल करती हैं। खाता कुंजियाँ /api/skimle-account को कॉल करती हैं।

3

API संदर्भ खोलें

विवरण, अनुरोध संरचनाओं और आज़माने वाले पैनल के साथ हर एंडपॉइंट देखें। हर रूट action पर आधारित discriminated union बॉडी स्वीकार करता है।

कच्चा OpenAPI 3.1 स्पेक यहाँ उपलब्ध है: /api/openapi.json.

बनाने के लिए तैयार?

अपनी परियोजना कुंजियाँ प्रबंधित करें, या एजेंटिक क्लाइंट के लिए MCP सर्वर देखें।