Chat Completions

POST https://api.shannon-ai.com/v1/chat/completions

સૌથી નાની રિક્વેસ્ટ એટલે મોડેલ id અને એક user મેસેજ.

from openai import OpenAI

client = OpenAI(
    api_key="YOUR_API_KEY",
    base_url="https://api.shannon-ai.com/v1",
)

response = client.chat.completions.create(
    model="shannon-3",
    messages=[{"role": "user", "content": "Say hello in one sentence."}],
)

print(response.choices[0].message.content)

import OpenAI from "openai";

const client = new OpenAI({
  apiKey: "YOUR_API_KEY",
  baseURL: "https://api.shannon-ai.com/v1",
});

const response = await client.chat.completions.create({
  model: "shannon-3",
  messages: [{ role: "user", content: "Say hello in one sentence." }],
});

console.log(response.choices[0].message.content);

curl https://api.shannon-ai.com/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "shannon-3",
    "messages": [{"role": "user", "content": "Say hello in one sentence."}]
  }'

જવાબ એક JSON ઓબ્જેક્ટ છે:

{
  "id": "chatcmpl-5f0c1e7a9b3d4c62a8e1f07d2b46c9a3",
  "object": "chat.completion",
  "created": 1791625200,
  "model": "shannon-3",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "Hello, it is good to meet you.",
        "reasoning_content": "The user wants a greeting in one sentence. Keep it short and friendly."
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 1184,
    "completion_tokens": 46,
    "total_tokens": 1230
  }
}

હેડર્સ

રિક્વેસ્ટ હેડર્સ

જવાબ હેડર્સ

રિક્વેસ્ટ ફીલ્ડ્સ

માત્ર messages જરૂરી છે. કોણ લાગુ કરે છે કૉલમ એ મોડેલ્સ જણાવે છે જેમાં ફીલ્ડ જવાબ બદલે છે. હોસ્ટેડ open-weight મોડેલ્સ મોડેલ યાદીના બાર id છે; Shannon 3 ફેમિલી એટલે shannon-3, shannon-3-pro, shannon-3.1 અને shannon-3.1-pro. મોડેલ્સ અને કિંમત

અન્ય OpenAI ફીલ્ડ્સ, જેમ કે n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store અને prompt_cache_key, સ્વીકારાય છે જેથી હાલનો ક્લાયન્ટ કોડ બદલ્યા વિના ચાલે. તે જવાબ બદલતા નથી: હંમેશા એક જ choice હોય છે, અને સ્ટ્રીમ હંમેશા વપરાશ સાથે પૂરો થાય છે.

ખોટા JSON પ્રકારવાળું ફીલ્ડ, ઉદાહરણ તરીકે "max_tokens": "100", 422 પાછું આપે છે. messages વિનાની રિક્વેસ્ટ પણ તેમ જ કરે છે.

ટૂલ્સ, સ્ટ્રક્ચર્ડ આઉટપુટ, reasoning અને વેબ સર્ચ દરેકનું પોતાનું પેજ છે: ફંક્શન કોલિંગ, રચિત આઉટપુટ્સ, Reasoning effort, Built‑in Web Search.

વિકલ્પો સાથેની રિક્વેસ્ટ

આ રિક્વેસ્ટ system મેસેજ, સેમ્પલિંગ ફીલ્ડ્સ અને reasoning effort સેટ કરે છે. તે હોસ્ટેડ open-weight મોડેલ વાપરે છે, જે આ બધું લાગુ કરે છે.

from openai import OpenAI

client = OpenAI(
    api_key="YOUR_API_KEY",
    base_url="https://api.shannon-ai.com/v1",
)

response = client.chat.completions.create(
    model="DeepSeek-V4-Flash-0731-W4A16-AUTOROUND-REAP",
    messages=[
        {"role": "system", "content": "You are a physics teacher. Answer in two sentences."},
        {"role": "user", "content": "Why is the sky blue?"},
    ],
    max_tokens=512,
    temperature=0.3,
    top_p=0.9,
    seed=7,
    stop=["\n\n"],
    reasoning_effort="low",
)

message = response.choices[0].message
print(message.reasoning_content)  # the reasoning
print(message.content)            # the answer
print(response.usage)

import OpenAI from "openai";

const client = new OpenAI({
  apiKey: "YOUR_API_KEY",
  baseURL: "https://api.shannon-ai.com/v1",
});

const response = await client.chat.completions.create({
  model: "DeepSeek-V4-Flash-0731-W4A16-AUTOROUND-REAP",
  messages: [
    { role: "system", content: "You are a physics teacher. Answer in two sentences." },
    { role: "user", content: "Why is the sky blue?" },
  ],
  max_tokens: 512,
  temperature: 0.3,
  top_p: 0.9,
  seed: 7,
  stop: ["\n\n"],
  reasoning_effort: "low",
});

const message = response.choices[0].message;
console.log(message.reasoning_content); // the reasoning
console.log(message.content);           // the answer
console.log(response.usage);

curl https://api.shannon-ai.com/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "DeepSeek-V4-Flash-0731-W4A16-AUTOROUND-REAP",
    "messages": [
      {"role": "system", "content": "You are a physics teacher. Answer in two sentences."},
      {"role": "user", "content": "Why is the sky blue?"}
    ],
    "max_tokens": 512,
    "temperature": 0.3,
    "top_p": 0.9,
    "seed": 7,
    "stop": ["\n\n"],
    "reasoning_effort": "low"
  }'

જવાબનો આકાર ઉપર જેવો જ છે. હોસ્ટેડ open-weight મોડેલ્સ પર તેનો usage બે વિગતો ઉમેરે છે: કેશમાંથી વંચાયેલા prompt ટોકન્સ અને reasoning પર ખર્ચાયેલા ટોકન્સ.

{
  "usage": {
    "prompt_tokens": 31,
    "completion_tokens": 62,
    "total_tokens": 93,
    "prompt_tokens_details": {
      "cached_tokens": 0
    },
    "completion_tokens_details": {
      "reasoning_tokens": 21
    }
  }
}

આઉટપુટ લંબાઈ

max_tokens બે કામ કરે છે. પહેલું, રિક્વેસ્ટ શરૂ થાય ત્યારે તમારા બેલેન્સમાંથી અલગ રખાતા ટોકન્સની સંખ્યા તે છે. જવાબ પૂરો થાય ત્યારે તે રકમ રિક્વેસ્ટે વાપરેલા ટોકન્સથી બદલાય છે. જો max_tokens તમારા બેલેન્સમાં બાકી છે તેના કરતાં મોટું હોય, તો જવાબ સમાઈ જાય તેમ હોય તો પણ રિક્વેસ્ટ 429 Quota exceeded પાછું આપે છે. ઓછું અલગ રાખવા ઓછું max_tokens મોકલો.

આ એન્ડપોઇન્ટ પર shannon-coder-1 અલગ રીતે ગણાય છે: દરેક રિક્વેસ્ટ તમારા પ્લાનનો એક Shannon Coder કોલ છે, અને તેના માટે કોઈ ટોકન્સ અલગ રખાતા નથી. મર્યાદાઓ અને બેલેન્સ

બીજું, તે આ મોડેલ્સ પર જવાબની લંબાઈ મર્યાદિત કરે છે:

max_tokens અથવા max_completion_tokens વિના કિંમત 4,096 છે. shannon-coder-1 પર તે 65,536 છે.

મેસેજ

દરેક મેસેજ role અને content ધરાવતો ઓબ્જેક્ટ છે. content સ્ટ્રિંગ છે, અથવા મેસેજ ટેક્સ્ટ કરતાં વધુ લઈ જતો હોય ત્યારે ભાગોની એરે.

Shannon 3 ફેમિલી id સાથે, જે સૂચનાઓ પળાવી જ જોઈએ તે user મેસેજમાં મૂકો.

Shannon ટિયર પર user ટેક્સ્ટ વિનાની અને tools વિનાની રિક્વેસ્ટ 400 No user message provided પાછું આપે છે.

કન્ટેન્ટ ભાગો

કદ, મર્યાદાઓ અને સ્વરૂપોની સંપૂર્ણ યાદીનું પોતાનું પેજ છે. ઇમેજ અને ફાઇલ્સ

જવાબ ઓબ્જેક્ટ

સમાપ્તિનાં કારણો

સ્ટ્રીમ ન થતો જવાબ stop અથવા tool_calls જણાવે છે.

વપરાશ

હોસ્ટેડ open-weight મોડેલ્સ પર, prompt_tokens એટલે તમારા મેસેજ અને ટૂલ વ્યાખ્યાઓ મોડેલના પોતાના tokenizer થી ગણેલી, ઉપરાંત કોઈ ઇમેજના ટોકન્સ. ટોકન ગણતરી એન્ડપોઇન્ટ્સ તમે મોકલો તે પહેલાં એ જ સંખ્યા પાછી આપે છે. ટોકન ગણતરી

Shannon ટિયર પર, prompt_tokens જવાબ લખવા મોડેલે જે બધું વાંચ્યું તે ગણે છે, તેથી તે તમારા મેસેજના ટેક્સ્ટ કરતાં મોટું હોય છે.

Streaming

stream ને true સેટ કરવાથી જવાબ chat.completion.chunk ઇવેન્ટ્સ તરીકે આવે છે અને data: [DONE] સાથે પૂરો થાય છે. તેની પહેલાંનો છેલ્લો chunk finish_reason અને usage લઈ જાય છે; કોઈ stream_options જરૂરી નથી. chunk ના આકારો, keep-alive લાઇન્સ અને સ્ટ્રીમની અંદરની એરરનું પોતાનું પેજ છે. સ્ટ્રીમિંગ

એરર્સ

એરર એટલે error સભ્ય ધરાવતો JSON ઓબ્જેક્ટ. તપાસ આ ક્રમમાં થાય છે: API કી, રિક્વેસ્ટ બોડી, મોડેલ id, પછી બેલેન્સ. ટેબલ આ એન્ડપોઇન્ટ સૌથી વધુ વાર શું પાછું આપે છે તે બતાવે છે. કઈ એરર ફરી અજમાવવી તે સાથેની સંપૂર્ણ યાદીનું પોતાનું પેજ છે. ભૂલ સંભાળ

{
  "error": {
    "type": "invalid_request_error",
    "message": "unknown model: no-such-model"
  }
}