अल्टीमेट डेवलपर एपीआई गाइड

सभी एपीआई एंडपॉइंट को 'प्राधिकरण' हेडर में एक चिरप्स एपीआई कुंजी की आवश्यकता होती है। आप अपने डैशबोर्ड के [डेवलपर अनुभाग] (https://chirps.cc/dashboard/developers) में एपीआई प्रबंधक से एक एपीआई कुंजी उत्पन्न कर सकते हैं।

Authorization: Bearer <YOUR_CHIRPS_API_KEY>

उदाहरण अनुरोध:

curl -X GET https://chirps.cc/api/billing/usage \
  -H "Authorization: Bearer <YOUR_CHIRPS_API_KEY>" \
  -H "Content-Type: application/json"

मानक त्रुटि प्रबंधन

सहायकों की सूची बनाएं

एपीआई कुंजी के कार्यक्षेत्र से जुड़े सभी सहायकों की एक सूची प्राप्त करता है।

एक सहायक बनाएँ

पोस्ट /एपीआई/सहायक

सभी आधार कॉन्फ़िगरेशन के साथ एक नया सहायक बनाता है।

{

  "businessName": "Acme Corp",
  "businessUrl": "https://acme.com",
  "knowledgeBaseType": "both",
  "knowledgeBaseUrl": "https://acme.com/help",
  "knowledgeBaseText": "Raw text content of a document...",
  "knowledgeBaseFileName": "company_handbook.pdf",
  "language": "en",
  "isMultiLanguage": false,
  "tonePersonality": "professional",
  "isCustomPersonality": false,
  "supportEmail": "[email protected]",
  "maxPages": 5,
  "maxDepth": 2,
  "welcomeMessageDelay": 2
}

सहायक हटाएँ

हटाएं /api/assistant/:id

सहायक को स्थायी रूप से हटा देता है और उसके सभी ज्ञान नोड्स और इतिहास को कैस्केडिंग रूप से हटा देता है। किसी पेलोड की आवश्यकता नहीं है.

प्राप्त करें /api/analytics/अवलोकन?assistantId=uuid&range=30

निर्दिष्ट सहायक के लिए उपयोग के आँकड़े, कुल संदेश, प्राप्त लीड और सामान्य सहभागिता मेट्रिक्स प्राप्त करें। रेंज पैरामीटर वैकल्पिक है (दिनों की संख्या, न्यूनतम 7, अधिकतम 365, डिफ़ॉल्ट 30)।

अपेक्षित प्रतिक्रिया

{

  "totalConversations": 1245,
  "totalMessages": 8420,
  "totalLeads": 156,
  "totalBookings": 42,
  "satisfactionRate": 94,
  "avgMessagesPerSession": 6.7,
  "avgSessionsPerDay": 41.5,
  "liveNow": 3,
  "onlineNow": 12,
  "dailySeries": [
    {
      "date": "2026-07-15",
      "conversations": 45,
      "messages": 310,
      "leads": 5,
      "bookings": 2
    }
  ],
  "agentStats": [
    {
      "name": "Jane Doe",
      "messagesSent": 120,
      "csat": 98
    }
  ]
}

ज्ञान नोड्स का प्रबंधन

GET /api/assistants/:id/nodes - इस सहायक के लिए सभी ज्ञान नोड्स की सूची बनाएं।

POST /api/assistants/:id/nodes - मैन्युअल रूप से एक नया ज्ञान ब्लॉक इंजेक्ट करें।

{

  "title": "Return Policy",
  "refined_content": "We offer a 30-day return policy for all unused items...",
  "type": "text",
  "metadata": {}
}

पैच /api/assistant/:id/nodes/:nodeId - मौजूदा नोड की सामग्री को संशोधित करें या इसकी सक्रिय स्थिति को टॉगल करें।

{

  "title": "Updated Return Policy",
  "refined_content": "We offer a 60-day return policy now...",
  "is_active": true
}

DELETE /api/assistant/:id/nodes/:nodeId - किसी नॉलेज ब्लॉक को पूरी तरह हटा दें।

POST /api/assistant/:id/nodes/:nodeId/re-crawl - स्क्रैपर को इस नोड से जुड़े URL को फिर से क्रॉल करने और इसकी सामग्री को अपडेट करने के लिए बाध्य करें। पेलोड: {}.

एआई प्रशिक्षण

POST /api/assistant/:id/train - सभी is_active ज्ञान नोड्स को संकलित करें और एक नए मास्टर सिस्टम प्रॉम्प्ट को गतिशील रूप से संश्लेषित करने के लिए AI ऑर्केस्ट्रेटर का उपयोग करें। पेलोड: {}.

विजेट उपस्थिति अद्यतन करें

पैच /api/assistant/:id/widget-config

{

  "primaryColor": "#000000",
  "position": "bottom-right",
  "language": "en",
  "welcomeMessage": "Hi! How can I help you today?",
  "title": "Acme Support",
  "theme": "light",
  "fontFamily": "default",
  "bubbleStyle": "circle",
  "bubbleText": "Chat with us",
  "headerSubtitle": "We typically reply instantly",
  "inputPlaceholder": "Type your message...",
  "privacyPolicyUrl": "https://acme.com/privacy",
  "voiceEnabled": true,
  "voiceName": "Fenrir",
  "welcomeMessageDelay": 2,
  "fileUploadEnabled": true,
  "dictationEnabled": true,
  "copilotEnabled": true,
  "welcomeSuggestions": ["Pricing plans", "Contact sales"],
  "pageVisibility": {
    "mode": "all",
    "paths": []
  }
}

उपलब्ध ध्वनि नाम

• महिला: ज़ेफिर, एओडे, कोर, लेडा, कैलिरो, डेस्पिना, एरिनोम, लाओमेडिया, अचर्नार, पुलचेरिमा, गैक्रक्स, अल्जेनिब, सल्फ़ैट
• पुरुष: पक, चारोन, फेनरीर, ओरस, एन्सेलाडस, इपेटस, अम्ब्रिएल, अल्गीबा, ऑटोनो, रसलगेथी, अलनीलम

कस्टम लोगो

पोस्ट /एपीआई/असिस्टेंट्स/:आईडी/विजेट-लोगो

प्रारूप: फ़ाइल फ़ील्ड के साथ मल्टीपार्ट/फ़ॉर्म-डेटा।

विकल्प ए: वेब एंबेड (फ्रंटएंड)

सहायक को एक मानक वेबसाइट (वर्डप्रेस, शॉपिफाई, रिएक्ट, आदि) में एकीकृत करने का सबसे आसान तरीका। एंबेड कोड पूरी तरह से नियतात्मक है। इसे लाने के लिए आपको किसी समापन बिंदु की आवश्यकता नहीं है। बस इसे अपनी साइट के <head> में छोड़ें:

<script src="https://chirps.cc/widget.js" data-assistant-id="YOUR_ASSISTANT_ID_HERE"></script>

विकल्प बी: हेडलेस इंटीग्रेशन (बैकएंड/सीआरएम/बॉट्स)

यदि आप एक कस्टम क्लाइंट (जैसे डिस्कोर्ड बॉट, टेलीग्राम इंटीग्रेशन, या देशी आईओएस ऐप) बना रहे हैं, तो आप वेब एंबेड का उपयोग नहीं करेंगे। इसके बजाय, आप सीधे /api/chat समापन बिंदु से इंटरैक्ट करेंगे।

पोस्ट /api/chat या /api/chat?stream=true

ध्यान दें: यह समापन बिंदु सार्वजनिक है और इसके लिए प्राधिकरण: बियरर एपीआई कुंजी हेडर की *नहीं* आवश्यकता है। प्रमाणीकरण को assistantId के माध्यम से अंतर्निहित रूप से नियंत्रित किया जाता है।

{

  "assistantId": "123e4567-e89b-12d3-a456-426614174000",
  "sessionId": "unique-session-id-for-user",
  "conversationId": "optional-uuid",
  "message": "Hello, I need help with my billing."
}

*(यदि fileUploadEnabled सत्य है तो संलग्नक के लिए फ़ाइल फ़ील्ड के साथ मल्टीपार्ट/फ़ॉर्म-डेटा का भी समर्थन करता है)।*

मोड 1: मानक JSON प्रतिक्रिया (डिफ़ॉल्ट)

/api/chat (स्ट्रीम पैरामीटर के बिना) पर एक POST अनुरोध भेजकर, आप पूर्ण AI प्रतिक्रिया की प्रतीक्षा करते हैं और एक मानक JSON ऑब्जेक्ट प्राप्त करते हैं।

{

  "message": "Here is the information you requested...",
  "conversationId": "uuid-of-conversation",
  "messageId": "uuid-of-message"
}

*(यदि is_active_agent: true लौटाया जाता है, तो एक मानव ने चैट पर कब्जा कर लिया है, और संदेश शून्य होगा।)*

मोड 2: सर्वर-भेजे गए इवेंट स्ट्रीमिंग (?stream=true)

URL में ?stream=true जोड़कर, आपको एक वास्तविक समय सर्वर-भेजे गए इवेंट (SSE) स्ट्रीम प्राप्त होती है। आपके कोड को इन विशिष्ट ईवेंट प्रकारों को सुनना चाहिए:

• `इवेंट: टोकन`: इसमें {"टेक्स्ट": "चंक"} शामिल है। एआई के प्रतिक्रिया पाठ के प्रत्येक भाग के लिए निकाल दिया गया।
• `घटना: स्थिति`: इसमें {"पाठ": "ज्ञान का आधार खोज रहा है..."} शामिल है। बैकएंड टूल निष्पादन स्थितियों का प्रतिनिधित्व करता है।
• `इवेंट: हो गया`: इसमें {"messageId": "uuid", "conversationId": "uuid", "message": "full text"} शामिल है। जब पीढ़ी पूरी तरह से समाप्त हो जाए तो निकाल दिया जाता है।
• `घटना: त्रुटि`: इसमें {"त्रुटि": "त्रुटि संदेश"} शामिल है। यदि दर सीमा या त्रुटियाँ होती हैं तो निकाल दिया जाएगा।

लाइव टेकओवर समापन बिंदु

प्राप्त करें /एपीआई/चैट/सत्र

ऐतिहासिक सत्र पुनः प्राप्त करें.

पोस्ट /एपीआई/चैट/टॉगल-एजेंट

मानव अधिग्रहण के लिए AI को रोकें। पेलोड: { "sessionId": "..." }

पोस्ट /एपीआई/चैट/एजेंट-संदेश

मानवीय संदेश भेजें. पेलोड: { "सत्रआईडी": "...", "संदेश": "..." }

कोर कॉन्फ़िगरेशन अद्यतन करें

सहायक की मुख्य सेटिंग्स, व्यक्तित्व और स्क्रैपिंग सीमा को संशोधित करें।

{

  "business_name": "Acme Corp",
  "business_url": "acme.com",
  "business_description": "We sell anvils.",
  "system_prompt": "You are a helpful assistant.",
  "language": "en",
  "tone_personality": "Friendly",
  "support_email": "[email protected]",
  "additional_instructions": "Never mention the Roadrunner.",
  "is_multi_language": true,
  "is_dev_mode": false,
  "is_active": true,
  "max_pages": 15,
  "max_depth": 2,
  "widget_config_merge": {
    "rateLimitEnabled": true
  }
}

*नोट: सभी फ़ील्ड वैकल्पिक हैं। केवल वही फ़ील्ड भेजें जिन्हें आप अपडेट करना चाहते हैं।*

सहायक हटाएँ

हटाएं /api/assistant/:id

सहायक को स्थायी रूप से हटा देता है और सभी ज्ञान नोड्स, वार्तालापों और संदेशों को कैस्केड रूप से हटा देता है। यदि सहायक कभी भी पूरी तरह से सेट नहीं किया गया था, तो यह मासिक निर्माण कोटा वापस कर देता है।

पोस्ट /api/phone-numbers/:id/assign - एक नंबर प्रदान करें। पेलोड: {}

पोस्ट /एपीआई/असिस्टेंट्स/:आईडी/आउटबाउंड - आउटबाउंड कॉल ट्रिगर करें। पेलोड: { "से": "+123...", "संदेश": "..." }

GET /api/leads?id=leadId - संपूर्ण वार्तालाप प्रतिलेख सहित एकल लीड का विवरण प्राप्त करें।

GET /api/bookings?id=bookingId - वार्तालाप प्रतिलेख सहित एकल बुकिंग का विवरण प्राप्त करें।

पोस्ट /एपीआई/बुकिंग/रद्द करें - एक सक्रिय बुकिंग रद्द करें। पेलोड: { "बुकिंग आईडी": "यूयूआईडी" }

पोस्ट /एपीआई/बुकिंग/रीशेड्यूल - बुकिंग समायोजित करें। पेलोड: { "बुकिंगआईडी": "यूयूआईडी", "न्यूटाइम": "आईएसओ-8601" }

कार्यक्षेत्र के बिलिंग चक्र उपयोग, सदस्यता योजना सीमा और कुल सहायक गणना पुनः प्राप्त करें। ध्यान दें: एपीआई कुंजी का उपयोग करते समय, अनुरोध स्वचालित रूप से एपीआई कुंजी के कार्यक्षेत्र में आ जाता है; आपको टीमआईडी प्रदान करने की आवश्यकता नहीं है।

प्रतिक्रिया ('200 ठीक'):

{

  "planName": "Pro",
  "periodStr": "2023-10-01",
  "assistantCount": 3,
  "usage": {
    "message_count": 1450,
    "harvest_count": 12,
    "recrawl_count": 5,
    "train_count": 2,
    "assistants_created_count": 1,
    "voice_minutes_used": 0,
    "sms_count": 0,
    "email_count": 0,
    "whatsapp_count": 0
  },
  "limits": {
    "messages": 5000,
    "assistants": 5,
    "training": 50,
    "recrawls": 20
  },
  "workspaceOwnerId": "uuid"
}