Developer guide
API কী দিয়ে প্রমাণীকরণ করা
API কী দেওয়ার হেডার এবং SDK-তে সেট করার base URL
এই পৃষ্ঠায় CLEVI গেটওয়েতে API কী দিয়ে প্রমাণীকরণের পদ্ধতি বর্ণনা করা হয়েছে।
OpenAI-সামঞ্জস্যপূর্ণ পথ এবং Anthropic-সামঞ্জস্যপূর্ণ পথ—উভয় ক্ষেত্রেই একটি কী দিয়ে প্রমাণীকরণ করা হয়,
তবে কী দেওয়ার হেডারের অনুমোদিত পরিসর এবং SDK-তে সেট করার base URL প্রতিটি স্পেসিফিকেশন অনুযায়ী আলাদা।
প্রমাণীকরণ হেডার
উভয় সামঞ্জস্যপূর্ণ স্পেসিফিকেশনেই একটি API কী দিয়ে প্রমাণীকরণ করা হয়। কী কনসোলের API কী স্ক্রিন থেকে ইস্যু করা হয় এবং একই স্ক্রিনে তা বাতিল করা ও ব্যবহারের পরিসর পরিচালনা করা যায়।
| হেডার | OpenAI-সামঞ্জস্যপূর্ণ | Anthropic-সামঞ্জস্যপূর্ণ |
|---|---|---|
| X-API-Key: <키> | ব্যবহার করা যায় | ব্যবহার করা যায় |
| Authorization: Bearer <키> | ব্যবহার করা যায় | ব্যবহার করা যায় |
| Authorization: <키> (Bearer ছাড়া) | প্রত্যাখ্যাত | ব্যবহার করা যায় |
হেডারের নামের ক্ষেত্রে বড় হাতের ও ছোট হাতের অক্ষরের পার্থক্য প্রযোজ্য নয়। Anthropic SDK যে x-api-key পাঠায়, সেটিও অপরিবর্তিতভাবে কাজ করে।
base URL
আপনি যে SDK ব্যবহার করছিলেন, তাতে শুধু base URL নিচের ঠিকানায় পরিবর্তন করলেই সেটি আগের মতো ব্যবহার করা যায়। দুটি ঠিকানার মধ্যে পার্থক্য হলো /v1 অন্তর্ভুক্ত আছে কি না।
| স্পেসিফিকেশন | base URL | পথের নিয়ম |
|---|---|---|
| OpenAI-সামঞ্জস্যপূর্ণ | https://platform.clevi.net/api/v2/aiservice/openai/v1 | /v1 পর্যন্ত base URL-এর মধ্যে অন্তর্ভুক্ত করুন। |
| Anthropic-সামঞ্জস্যপূর্ণ | https://platform.clevi.net/api/v2/aiservice/anthropic | Anthropic SDK নিজে পথের শেষে /v1 যোগ করে, তাই /v1-এর আগে শেষ হয়। |
প্রমাণীকরণ যাচাই
কী এবং base URL যোগ করে মডেলের তালিকা 조회 করলে প্রমাণীকরণ হয়েছে কি না তা সঙ্গে সঙ্গে জানা যায়। নিচের তিনটি একই 조회 curl, OpenAI SDK এবং Anthropic SDK দিয়ে করে।
curl https://platform.clevi.net/api/v2/aiservice/openai/v1/models \
-H "X-API-Key: sk-..."
curl https://platform.clevi.net/api/v2/aiservice/anthropic/v1/models \
-H "Authorization: Bearer sk-..." \
-H "anthropic-version: 2023-06-01"from openai import OpenAI
client = OpenAI(
api_key="sk-...",
base_url="https://platform.clevi.net/api/v2/aiservice/openai/v1",
)
for model in client.models.list():
print(model.id)from anthropic import Anthropic
client = Anthropic(
api_key="sk-...",
base_url="https://platform.clevi.net/api/v2/aiservice/anthropic",
)
for model in client.models.list(limit=20).data:
print(model.id)sk-...-এর জায়গায় API কী স্ক্রিন থেকে ইস্যু করা কীটি দিন।
- উত্তর 200 হলে প্রমাণীকরণ সম্পন্ন হয়েছে। data-তে এই কী দিয়ে কল করা যায় এমন মডেলের তালিকা থাকে।
- উত্তর 401 হলে নিচের প্রমাণীকরণ ব্যর্থতা বিভাগের ক্রম অনুযায়ী যাচাই করুন।
একসঙ্গে ব্যবহার করা হেডার
সবই ঐচ্ছিক। সমস্যা ট্র্যাক করতে X-Request-Id রাখা ভালো।
| হেডার | ব্যবহার | বাদ দিলে |
|---|---|---|
| X-Request-Id | অনুরোধ ট্র্যাক করার শনাক্তকারী। Anthropic-সামঞ্জস্যপূর্ণ প্রতিক্রিয়ায় request-id হেডার হিসেবে ফিরে আসে। | সার্ভার ইস্যু করে। |
| X-Region-Code | কলের অঞ্চল | global হয়। |
| X-Product-Sku (কোয়েরি product_sku দিয়েও দেওয়া যায়) | বিলিংয়ে ব্যবহারের জন্য Product SKU সরাসরি নির্ধারণ করে। হেডার কোয়েরির চেয়ে অগ্রাধিকার পায় এবং মূলত ভয়েস·ভয়েস পাথে ব্যবহৃত হয়। | ভয়েস পাথে প্রয়োজন। audio/speech এবং audio/transcriptions মূল অংশের model দিয়ে Product নির্বাচন করে। |
| anthropic-version / anthropic-beta | Anthropic-সামঞ্জস্যপূর্ণ পাথে অপরিবর্তিতভাবে ফরোয়ার্ড করা হয়। | সংস্করণ 2023-06-01। |
প্রমাণীকরণ ব্যর্থ
কী না থাকলে বা মেয়াদোত্তীর্ণ·বাতিল করা কী পাঠালে 401 হয়। OpenAI-সামঞ্জস্যপূর্ণ পাথে কী ছাড়া কল করলে নিচের বডি পাওয়া যায়, আর Anthropic-সামঞ্জস্যপূর্ণ পাথের error.type হলো authentication_error।
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}- API কী স্ক্রিনে কী-এর অবস্থা পরীক্ষা করুন। মেয়াদোত্তীর্ণ·বাতিল করা কী হলে নতুন কী ইস্যু করুন।
- হেডারের নাম X-API-Key নাকি Authorization তা পরীক্ষা করুন।
- OpenAI-সামঞ্জস্যপূর্ণ পাথে Authorization ব্যবহার করলে Bearer প্রিফিক্স পরীক্ষা করুন।
