चेंजलॉग

यह पृष्ठ डेवलपर API अनुबंध में परिवर्तनों को ट्रैक करता है ताकि आप उस सरफेस को ट्रैक कर सकें जिस पर आपका इंटीग्रेशन निर्भर करता है।

v1 — स्थिर (2026-06)

Cuneiform Chat डेवलपर API की प्रारंभिक सार्वजनिक रिलीज़। v1 वर्तमान, स्थिर अनुबंध है और इस रेफरेंस में दस्तावेज़ित हर चीज़ के लिए बेसलाइन स्थापित करता है:

प्रमाणीकरण — एक cuk_<env>_<random> key के साथ क्रेडेंशियल-संरक्षित पहुँच, जिसे Authorization: Bearer cuk_… या X-API-Key: cuk_… के रूप में प्रस्तुत किया जाता है। पाँच scopes: knowledge:read, knowledge:write, agents:read, agents:write, agents:query।
Knowledge — एसिंक्रोनस डॉक्यूमेंट अपलोड, सूची, सर्च, प्राप्ति, स्टेटस (पोल + SSE) और डिलीट; फ़ोल्डर और tag CRUD; डॉक्यूमेंट संगठन (फ़ोल्डर में ले जाना, tags जोड़ना/हटाना)।
Agents — बनाना, सूचीबद्ध करना, प्राप्त करना, अपडेट करना, आर्काइव (soft-delete) करना और पुनर्स्थापित करना; एक agent के कॉन्फ़िगरेशन को पढ़ना और अपडेट करना।
Agent क्वेरी — ब्लॉकिंग JSON मोड या स्ट्रीमिंग SSE मोड में एक agent चलाना।
कन्वेंशन — अपारदर्शी कर्सर पेजिनेशन, Idempotency-Key अनुबंध, Stripe-शैली त्रुटि एनवेलप, और RateLimit-* हेडर।

अनुबंध कैसे विकसित होता है

v1 योगात्मक और स्थिर है:

v1 के भीतर नए फ़ील्ड और नए endpoints प्रस्तुत किए जा सकते हैं।
मौजूदा फ़ील्ड v1 के भीतर कभी हटाए या पुनः उपयोग नहीं किए जाते।
त्रुटि श्रेणियाँ कभी पुनः उपयोग नहीं की जातीं — एक नई श्रेणी जोड़ी जा सकती है, लेकिन एक मौजूदा श्रेणी अपना अर्थ बनाए रखती है, इसलिए त्रुटि के type पर शाखाबद्ध करना सुरक्षित है।

एक ब्रेकिंग परिवर्तन एक नए वर्ज़न प्रिफ़िक्स (/v2) के अंतर्गत जारी होगा, कभी v1 के भीतर चुपचाप नहीं।