assistant

POST /v1/assistant/conversations

Start a new assistant conversation.

सभी assistant एंडपॉइंट्स

सभी डेवलपर दस्तावेज़

प्रमाणन

बेरर टोकन के रूप में एक API कुंजी भेजें। कुंजी के पास tickets.reply अनुमति होनी चाहिए; इसके बिना एक कुंजी को 404 के बजाय 403 के साथ अस्वीकार कर दिया जाता है।

जहां आपकी संगठन आईडी आती है

यह एंडपॉइंट JSON बॉडी में एक फ़ील्ड के रूप में org_id लेता है।

आपकी ऑर्गनाइजेशन आईडी आपके डैशबोर्ड पर एपीआई कीज़ स्क्रीन पर, की के ठीक बगल में मौजूद है। यह आपके द्वारा की जाने वाली हर कॉल में समान आईडी होती है।

इसे आज़माएँ

कोणार्कित ब्रैकेट्स में दी गई किसी भी चीज़ को अपने मानों से बदलें, और की प्लेसहोलर को अपने डैशबोर्ड की एक की से बदलें।

curl -X POST https://api.zinndigital.com/v1/assistant/conversations \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

साइन इन हैं? आपके डैशबोर्ड में मौजूद API कंसोल आपकी वास्तविक संगठन आईडी और आपकी अपनी कुंजी स्वतः भर देता है, और लाइव API के विरुद्ध अनुरोध चलाता है ताकि आप वास्तविक प्रतिक्रिया देख सकें। इस एंडपॉइंट को API कंसोल में खोलें

विवरण

Creates an empty thread. Nothing is sent to a model until you post a message. Requires tickets.reply.

अनुरोध बॉडी

नामप्रकारआवश्यकयह क्या है
org_idUuidनहींRequired only when you can act in more than one organization.

प्रतिक्रिया

नामप्रकारआवश्यकयह क्या है
idUuidहाँUUIDv7 identifier — sortable by creation time (docs/02 §8).
titlestringहाँThe first question, truncated, so a list of threads is readable.
escalated_ticket_idUuidहाँSet once this thread became a support ticket.
created_atstringहाँ
updated_atstringहाँ

त्रुटियाँ जो यह एंडपॉइंट लौटा सकता है

401 · 403 · 422 · 429