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

सभी एपीआई एंडपॉइंट को 'प्राधिकरण' हेडर में एक चिरप्स एपीआई कुंजी की आवश्यकता होती है। आप अपने डैशबोर्ड के [डेवलपर अनुभाग] (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"

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

स्कोप और न्यूनतम विशेषाधिकार

हर कुंजी केवल चुने गए स्कोप तक सीमित रहती है। जहाँ संभव हो केवल-पढ़ने वाली कुंजी उपयोग करें और हर इंटीग्रेशन के लिए अलग कुंजी बनाएँ। लिखने का स्कोप संबंधित पढ़ने का स्कोप स्वतः नहीं देता।

assistants:read
assistants:write
analytics:read
artifacts:read
artifacts:write
billing:read
bookings:read
bookings:write
chat:write
connectors:read
connectors:write
conversations:read
conversations:write
knowledge:read
knowledge:write
leads:read
leads:write
telephony:read
telephony:write
widget:write

API-key rate limit

Each developer key is limited to 300 requests per rolling minute by default. The limit is atomic across all application instances and can be changed by the platform with API_KEY_RATE_LIMIT_PER_MINUTE. A rejected request returns 429; retry only after the window resets.

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

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

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

POST /एपीआई/सहायक

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

{

  "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
}

सहायक हटाएँ

DELETE /api/assistants/:id

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

Creation validation and quota safety

Creation allowance is reserved atomically before insertion, so concurrent requests cannot exceed the monthly quota. Database insertion failures refund that reservation. A created assistant starts inactive in developer mode; call the setup endpoint and wait for its successful terminal event before publishing it.

GET /api/analytics/overview?assistantId=uuid&range=30अवलोकन?assistantId=uuid&range=30

निर्दिष्ट सहायक के लिए उपयोग के आँकड़े, कुल संदेश, प्राप्त लीड और सामान्य सहभागिता मेट्रिक्स प्राप्त करें। range पैरामीटर वैकल्पिक है (दिनों की संख्या, न्यूनतम 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": {}
}

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

{

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

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

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

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

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

Upload, crawl, and index consistency

PATCH /api/assistants/:id/widget-config

Send only the fields you want to change. The API rejects unknown keys and invalid nested data instead of silently storing configuration the widget cannot use.

{
  "designPreset": "corporate-soft",
  "primaryColor": "#1972F5",
  "theme": "dark",
  "bubbleStyle": "branded-drawer",
  "bubbleText": "Talk to our team",
  "welcomeMessages": [
    {
      "text": "Hello! How can I help?",
      "delay": 1.5
    }
  ],
  "welcomeSuggestions": [
    "View pricing",
    "Book a demo"
  ],
  "pageVisibility": {
    "mode": "exclude",
    "paths": [
      "/checkout/*"
    ]
  },
  "voiceEnabled": true,
  "voiceName": "Aoede",
  "copilotEnabled": true,
  "gdprConsentEnabled": true,
  "privacyPolicyUrl": "https://example.com/privacy"
}

Page visibility matching

Use exact paths such as /pricing, or append /* to include descendants such as /docs/*. include shows only matches; exclude hides matches; all ignores paths. Full URLs are normalized to their pathname by the widget.

Available voice names

Zephyr, Aoede, Kore, Leda, Callirrhoe, Despina, Erinome, Laomedeia, Achernar, Pulcherrima, Gacrux, Algenib, Sulafat, Puck, Charon, Fenrir, Orus, Enceladus, Iapetus, Umbriel, Algieba, Autonoe, Rasalgethi, Alnilam, Schedar, Sadachbia, Achird, Zubenelgenubi, Sadaltager

GET /api/assistants/:id/artifacts · PUT /api/assistants/:id/artifacts · PATCH /api/assistants/:id/artifacts

Artifacts are tool-driven UI. The model calls the enabled tool and Chirps renders it; integrations must send configuration JSON, never {{ARTIFACT: ...}} strings.

{
  "form": {
    "enabled": true,
    "title": "Request a quote",
    "description": "Collect the details needed for a quote.",
    "triggerRules": "When a visitor explicitly asks for a quote.",
    "fields": [
      {
        "key": "name",
        "label": "Full name",
        "type": "text",
        "required": true,
        "placeholder": "Jane Doe"
      },
      {
        "key": "email",
        "label": "Work email",
        "type": "email",
        "required": true
      }
    ],
    "submitLabel": "Request quote"
  },
  "booking": {
    "enabled": true,
    "title": "Book a consultation",
    "description": "Choose an available time.",
    "triggerRules": "When a visitor asks to book a meeting.",
    "services_enabled": false,
    "meetings_enabled": true,
    "requiresScheduling": true,
    "timezone": "Europe/Paris",
    "slotDuration": 30,
    "bufferMinutes": 10,
    "workingHours": {
      "monday": {
        "enabled": true,
        "start": "09:00",
        "end": "17:00"
      },
      "tuesday": {
        "enabled": true,
        "start": "09:00",
        "end": "17:00"
      },
      "wednesday": {
        "enabled": true,
        "start": "09:00",
        "end": "17:00"
      },
      "thursday": {
        "enabled": true,
        "start": "09:00",
        "end": "17:00"
      },
      "friday": {
        "enabled": true,
        "start": "09:00",
        "end": "17:00"
      },
      "saturday": {
        "enabled": false,
        "start": "10:00",
        "end": "14:00"
      },
      "sunday": {
        "enabled": false,
        "start": "10:00",
        "end": "14:00"
      }
    },
    "blockedDates": [
      "2026-12-25"
    ],
    "meeting_intake_fields": [
      {
        "key": "email",
        "label": "Email",
        "type": "email",
        "required": true
      }
    ],
    "submitLabel": "Book meeting"
  },
  "card": {
    "enabled": false,
    "ctaLabel": "View details",
    "ctaUrl": "",
    "description": "",
    "triggerRules": ""
  },
  "csat_survey": {
    "enabled": true,
    "title": "How was your experience?",
    "description": "One-click feedback.",
    "triggerRules": "Only after the request is resolved."
  },
  "custom": []
}

Field schema

Booking service schema

Validation limits and scheduling rules

Tool-call prefill behavior

Start with GET /api/marketplace/connectors. Its provider definitions are the source of truth for credential fields, configuration fields, available tools, defaults, and required values; this keeps custom and future providers discoverable without a documentation release.

{
  "provider": "shopify",
  "name": "Shopify",
  "credentials": {}
}

1. Install the workspace connector record with POST /api/assistants/:id/connectors; credentials must be omitted or {}.
2. Read its exact field schema from GET /api/marketplace/connectors and activate it with POST /api/assistants/:id/connectors/:connectorId/activate.
3. Send configValues, optional enabledTools, and optional instructions. Chirps verifies non-custom connectors and discovers the tools before saving the integration.
4. Rotate secrets by calling the activation endpoint again. PUT only renames a named Custom API.
5. Use DELETE /api/assistants/:id/connectors with { connectorId } to disable it for one assistant. Use the nested DELETE .../:connectorId only to permanently remove it from the workspace and every assistant.

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

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

<script>
  window.chirpsConfig = { assistantId: "YOUR_ASSISTANT_ID" };
</script>
<script src="https://chirps.cc/embed.js" async></script>

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

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

POST /api/chat या /api/chat?stream=true

महत्वपूर्ण: हेडलेस और सर्वर-टू-सर्वर कॉल में Authorization: Bearer <YOUR_CHIRPS_API_KEY> होना आवश्यक है। केवल इंस्टॉल किया गया ब्राउज़र विजेट सार्वजनिक origin-bound प्रवाह का उपयोग करता है। API कुंजी को फ्रंटएंड JavaScript में कभी न रखें।

{

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

*(यदि multipart/form-data सत्य है तो संलग्नक के लिए file फ़ील्ड के साथ 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 लौटाया जाता है, तो एक मानव ने चैट पर कब्जा कर लिया है, और message null होगा।)*

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

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

• `event: token`: इसमें {"text": "chunk"} शामिल है। एआई के प्रतिक्रिया पाठ के प्रत्येक भाग के लिए निकाल दिया गया।
• `event: status`: इसमें {"text": "Searching knowledge base..."} शामिल है। बैकएंड टूल निष्पादन स्थितियों का प्रतिनिधित्व करता है।
• `event: done`: इसमें {"messageId": "uuid", "conversationId": "uuid", "message": "full text"} शामिल है। जब पीढ़ी पूरी तरह से समाप्त हो जाए तो निकाल दिया जाता है।
• `event: error`: इसमें {"error": "Error message"} शामिल है। यदि दर सीमा या त्रुटियाँ होती हैं तो निकाल दिया जाएगा।

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

GET /एपीआई/चैट/सत्र

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

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

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

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

मानवीय संदेश भेजें. पेलोड: { "sessionId": "...", "message": "..." }

Complete chat response contract

{
  "message": "I've opened the booking calendar for you.",
  "messageId": "uuid",
  "conversationId": "uuid",
  "artifacts": [
    {
      "type": "booking",
      "title": "Book a consultation"
    }
  ],
  "sources": []
}

A human takeover returns { message: null, conversationId, is_active_agent: true }. A streaming request can therefore return JSON before an SSE stream begins; check the response Content-Type.

Complete SSE event reference

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

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

{

  "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
  }
}

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

सहायक हटाएँ

DELETE /api/assistants/:id

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

POST /api/phone-numbers/:subscriptionId/assign assigns an already-purchased Chirps phone subscription to an assistant. Send { "assistantId": "uuid" }; send { "assistantId": null } to unassign it. This endpoint does not purchase or provision a new number.

POST /एपीआई/असिस्टेंट्स/:आईडी/आउटबाउंड - आउटबाउंड कॉल ट्रिगर करें। पेलोड: { "phoneNumber": "+123...", "callReason": "Confirm the requested appointment", "conversationId": "optional-uuid" }

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

Public lead response

Lead objects contain id, assistant_id, conversation_id, session_id, name, email, phone, status, notes, artifact_id, ai_score, ai_summary, form_data, created_at, and the assistant business name. Internal voice-confirmation/idempotency identifiers are never returned.

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

DELETE /api/bookings/cancel?id=bookingId - सक्रिय बुकिंग रद्द करता है। &silent=true केवल तब जोड़ें जब आपका इंटीग्रेशन Chirps का बैकअप रद्दीकरण ईमेल जानबूझकर रोकता हो।

POST /एपीआई/बुकिंग/रीशेड्यूल - बुकिंग समायोजित करें। पेलोड: { "bookingId": "uuid", "newStartTime": "ISO-8601", "newEndTime": "ISO-8601" }

Public booking response and time zones

Booking objects contain the public appointment, guest, status, notes, and timestamp fields plus business_timezone. Times are ISO-8601 instants; format them in the viewer's time zone while preserving the returned business zone for schedule context. Internal confirmation IDs, provider calendar-event IDs, and database range columns are omitted.

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

प्रतिक्रिया ('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"
}

What belongs in the public developer API

These routes accept a scoped Chirps API key and enforce its workspace boundary. Dashboard-only billing/OAuth routes, browser widget callbacks, provider webhooks, cron jobs, and internal MCP routes are intentionally excluded.

Assistants

Knowledge and training

Widget, artifacts and connectors

Conversations, leads and bookings

Telephony and account