સારાંશ

એન્ડપોઇન્ટ્સ

દરેક એન્ડપોઇન્ટ એક base URL હેઠળ છે અને HTTPS પર પીરસાય છે.

https://api.shannon-ai.com

ટેક્સ્ટ બનાવતા ત્રણ એન્ડપોઇન્ટ્સ સમાન મોડેલ્સ સુધી પહોંચે છે. જેનું ફોર્મેટ તમારો કોડ પહેલેથી વાપરે છે તે પસંદ કરો.

રિક્વેસ્ટની મૂળભૂત બાબતો

• દરેક POST નો બોડી એક JSON ઓબ્જેક્ટ છે, 32 MiB સુધી.
• API જે ફીલ્ડ જાણતું નથી તેનાથી કોઈ એરર થતી નથી અને તેની કોઈ અસર નથી. બીજા પ્રદાતા માટે લખેલી રિક્વેસ્ટ વધારાના ફીલ્ડને કારણે નિષ્ફળ જતી નથી.
• ખોટા JSON પ્રકારવાળા જાણીતા ફીલ્ડનો, અથવા ખૂટતા જરૂરી ફીલ્ડનો જવાબ 422 થી અપાય છે. માન્ય JSON ન હોય તેવા બોડીનો જવાબ 400 થી અપાય છે.
• model એ Models & pricing પરના id માંનો એક છે. મોટા અને નાના અક્ષરો મહત્વના નથી.

જવાબ JSON હોય છે, અથવા રિક્વેસ્ટ stream ને true સેટ કરે ત્યારે server-sent events નો સ્ટ્રીમ. દરેક એન્ડપોઇન્ટ પોતાના ફોર્મેટમાં જવાબ આપે છે. દરેક જવાબમાં x-request-id હેડર હોય છે.

રિક્વેસ્ટ શું પસાર કરે છે

મોડેલ ચાલે તે પહેલાં રિક્વેસ્ટ નિશ્ચિત ક્રમમાં તપાસાય છે. જે પહેલી તપાસ નિષ્ફળ જાય તે જવાબ આપે છે, તેથી 401 હજી બોડી વિશે કંઈ જણાવતું નથી.

એરરનો આકાર

એરર એટલે type અને message ધરાવતો error ધરાવતો JSON ઓબ્જેક્ટ. /v1/messages તેને Anthropic SDK અપેક્ષા રાખે તેમ વીંટાળે છે; બીજા દરેક પાથ OpenAI આકાર વાપરે છે.

{
  "error": {
    "type": "invalid_request_error",
    "message": "unknown model: gpt-4o"
  }
}

{
  "type": "error",
  "error": {
    "type": "invalid_request_error",
    "message": "unknown model: gpt-4o"
  }
}

• type અને message વાંચો. code અને param માત્ર કેટલીક એરર્સ પર હાજર હોય છે: તેમને વૈકલ્પિક ગણો. param હંમેશા null છે.
• સ્ટ્રીમ શરૂ થયા પછી સ્ટેટસ પહેલેથી 200 હોય છે. ત્યારની નિષ્ફળતા સ્ટ્રીમની અંદર એરર ફ્રેમ તરીકે આવે છે.
• દરેક એરર જવાબ x-request-id હેડર લઈ જાય છે.

ભૂલ સંભાળ

બિલિંગ અને બેલેન્સ

• એકાઉન્ટ દીઠ એક બેલેન્સ છે, અને ચેટ અને API તેને વહેંચે છે: પહેલા આજનું પ્લાન એલાઉન્સ, પછી ખરીદેલ ક્રેડિટ. API પાસે પોતાનો કોઈ ક્વોટા નથી.
• રિક્વેસ્ટ તેનું આઉટપુટ બજેટ (max_tokens, ડિફોલ્ટ 4,096) અલગ રાખે છે અને પછી મોડેલની કિંમતે, તેણે ખરેખર વાપરેલા ટોકન્સનો ચાર્જ લાગે છે.
• દરેક જવાબ usage માં તેની ટોકન ગણતરી જણાવે છે. Keys & usage પેજ બેલેન્સ અને દરેક રિક્વેસ્ટનો ખર્ચ બતાવે છે.
• દરેક રિક્વેસ્ટ સમાન રીતે પીરસાય છે. રિક્વેસ્ટ દર પરની એકમાત્ર મર્યાદા flood protection છે: એકાઉન્ટ દીઠ પ્રતિ મિનિટ 120 રિક્વેસ્ટ. સમાંતર મોકલેલી રિક્વેસ્ટ્સ કતારમાં રાહ જુએ છે.

મર્યાદાઓ અને બેલેન્સ મોડેલ્સ અને કિંમત Keys & usage

મોડેલ પર આધારિત ફીલ્ડ્સ

દરેક મોડેલ સમાન રિક્વેસ્ટ લે છે. થોડા ફીલ્ડ્સ માત્ર અમુક મોડેલ્સ પર અસર કરે છે; ટેબલ જણાવે છે ક્યાં. એન્ડપોઇન્ટ પેજ દરેક ફીલ્ડ યાદી કરે છે.

Chat Completions

OpenAI SDK માંથી આવતા હોવ તો

• base URL ને https://api.shannon-ai.com/v1 અને કીને તમારી Shannon કી સેટ કરો. Chat Completions અને Responses કોલ્સ પછી SDK સાથે જેમ છે તેમ કામ કરે છે.
• model Shannon id હોવું જોઈએ. gpt-4o જેવા બીજા પ્રદાતાના મોડેલ નામનો જવાબ 400 અને unknown model થી અપાય છે.
• Reasoning પોતાના ફીલ્ડમાં આવે છે: content ની બાજુમાં reasoning_content, મેસેજમાં અને સ્ટ્રીમ deltas માં.
• સ્ટ્રીમ હંમેશા તેના છેલ્લા chunk માં finish_reason સાથે usage લઈ જાય છે.
• સ્ટ્રીમમાં ટૂલ કોલ સંપૂર્ણ arguments સ્ટ્રિંગ સાથે એક chunk તરીકે આવે છે.
• જવાબમાં એક choice હોય છે.
• ઉપરના ટેબલમાં ન હોય તેવા OpenAI API ના પાથ, જેમ કે /v1/embeddings, નો જવાબ 404 થી અપાય છે.

Anthropic SDK માંથી આવતા હોવ તો

• base URL ને https://api.shannon-ai.com, /v1 વિના, અને કીને તમારી Shannon કી સેટ કરો. SDK તેને x-api-key તરીકે મોકલે છે.
• model Shannon id હોવું જોઈએ.
• આ API પર max_tokens વૈકલ્પિક છે. તેનું ડિફોલ્ટ 4,096 છે.
• જવાબમાં thinking, text અને tool_use પ્રકારના કન્ટેન્ટ બ્લોક્સ હોય છે. પહેલો બ્લોક હંમેશા ટેક્સ્ટ હોતો નથી: બ્લોક્સ type થી પસંદ કરો.
• stop_reason end_turn અથવા tool_use છે. Shannon મોડેલનો સ્ટ્રીમ max_tokens સાથે પણ પૂરો થઈ શકે.
• anthropic-version અને anthropic-beta સ્વીકારાય છે, જેથી SDK બદલ્યા વિના કામ કરે. રિક્વેસ્ટને તેની જરૂર નથી.
• /v1/messages પરની એરર્સ Anthropic આકારની હોય છે: {"type": "error", "error": {…}}.

આ ફોર્મેટ બોલતા કોડિંગ ટૂલ્સ એ જ રીતે સેટ થાય છે: base URL, કી, અને મોડેલ તરીકે Shannon id. CLI કોડિંગ ટૂલ્સ