API রেফারেন্স

Cuneiform Chat-এর ডেভেলপার REST API আপনার ডেভেলপারদের knowledge ডকুমেন্ট পরিচালনা করতে, agents তৈরি ও কনফিগার করতে এবং প্রোগ্রাম্যাটিকভাবে agents চালাতে দেয় — অ্যাডমিন প্যানেল যে ক্ষমতাগুলো প্রকাশ করে, সেগুলোই একটি ক্রেডেনশিয়াল-সুরক্ষিত, ভার্সনড HTTP সারফেসের মাধ্যমে উপলব্ধ।

এই রেফারেন্স পাবলিক /v1 চুক্তিটি নথিভুক্ত করে: প্রতিটি endpoint, এর প্যারামিটার, একটি উদাহরণ অনুরোধ এবং প্রতিক্রিয়ার সঠিক রূপ।

বেস URL

সব endpoints একটি একক ভার্সনড বেস URL-এর অধীনে থাকে:

https://cuneiform.chat/api/developer/v1

একটি endpoint-এর সম্পূর্ণ পাথ হলো বেস URL এবং প্রতিটি পৃষ্ঠায় দেখানো পাথ — উদাহরণস্বরূপ, GET /agents হলো:

https://cuneiform.chat/api/developer/v1/agents

ভার্সনিং

API URL প্রিফিক্সে ভার্সনড (/v1)। কোনো হেডার-ভিত্তিক বা তারিখ-ভিত্তিক ভার্সনিং নেই — আপনি যে ভার্সনটি কল করেন সেটিই পাথের ভার্সন। /v1 চুক্তিটি স্থিতিশীল: ফিল্ড কেবল যোগ করা হয়, কখনো সরানো বা পুনঃব্যবহার করা হয় না, এবং একটি নতুন মেজর ভার্সন (যদি কখনো প্রয়োজন হয়) একটি নতুন প্রিফিক্সের অধীনে প্রকাশিত হবে। রিলিজ বেসলাইনের জন্য চেঞ্জলগ নোট দেখুন।

এক লাইনে প্রমাণীকরণ

প্রতিটি অনুরোধ একটি ডেভেলপার API key (cuk_…) দিয়ে প্রমাণীকৃত হয়, যা একটি Bearer টোকেন হিসেবে পাঠানো হয়:

Authorization: Bearer cuk_live_xxxxxxxxxxxxxxxx

Key আপনার organization এবং এটিকে দেওয়া scopes-এ সমাধান হয় — আপনি কখনো একটি organization id পাঠান না। সম্পূর্ণ চুক্তির জন্য প্রমাণীকরণ ও API Keys দেখুন।

আপনার প্রথম কল

1. একটি key তৈরি করুন। অ্যাডমিন প্যানেলে, /org/developer-api-তে ডেভেলপার কনসোল খুলুন, একটি key তৈরি করুন এবং সিক্রেটটি কপি করুন (এটি কেবল একবার দেখানো হয় — API Keys দেখুন)।
2. API কল করুন। আপনার agents তালিকাভুক্ত করুন:

curl https://cuneiform.chat/api/developer/v1/agents \
  -H "Authorization: Bearer cuk_live_xxxxxxxxxxxxxxxx"

একটি সফল প্রতিক্রিয়া একটি কার্সর-পেজিনেটেড পৃষ্ঠা:

{
  "data": [
    {
      "id": "agt_123",
      "name": "Support Bot",
      "status": "active"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

এই রেফারেন্স কীভাবে পড়বেন

প্রতিটি endpoint একটি এক-লাইনের বিবরণ, একটি প্যারামিটার টেবিল (path, query, header ও body), একটি উদাহরণ curl অনুরোধ এবং একটি উদাহরণ প্রতিক্রিয়া সহ নথিভুক্ত। প্রয়োজনীয় scope, সাফল্যের স্ট্যাটাস এবং প্রাসঙ্গিক ত্রুটির বিভাগগুলো প্রতিটি endpoint-এ উল্লেখ করা হয়।

OpenAPI স্পেসিফিকেশন

সম্পূর্ণ চুক্তিটি একটি হাতে-লেখা OpenAPI 3.1 স্পেসিফিকেশন, openapi.yaml হিসেবেও প্রকাশিত, যা এই রেফারেন্সের পাশে ডাউনলোডযোগ্য। এটিই একমাত্র সত্যের উৎস যার বিপরীতে এখানকার পৃষ্ঠাগুলো লেখা হয়েছে — প্রতিটি স্কিমা ফিল্ড এমন একটি যা API আসলেই ফেরত দেয়, এবং কোনো অভ্যন্তরীণ ফিল্ড উপস্থিত হয় না।

যোগ্যতা

ডেভেলপার REST API Starter ও তার উপরে উপলব্ধ। Trial organizations keys তৈরি করতে পারে না; একটি প্রচেষ্টা একটি 403 tier_error ফেরত দেয়।