అవలోకనం

ఎండ్‌పాయింట్‌లు

ప్రతి ఎండ్‌పాయింట్ ఒక బేస్ URL కింద ఉంటుంది మరియు HTTPS ద్వారా అందించబడుతుంది.

https://api.shannon-ai.com

టెక్స్ట్‌ను ఉత్పత్తి చేసే మూడు ఎండ్‌పాయింట్‌లు అవే మోడల్స్‌ను చేరుకుంటాయి. మీ కోడ్ ఇప్పటికే ఉపయోగించే ఫార్మాట్ ఉన్నదాన్ని ఎంచుకోండి.

రిక్వెస్ట్ ప్రాథమికాలు

• ప్రతి POST బాడీ ఒక JSON ఆబ్జెక్ట్, 32 MiB వరకు.
• APIకి తెలియని ఫీల్డ్ ఎరర్‌ను కలిగించదు మరియు ప్రభావం చూపదు. మరో ప్రొవైడర్ కోసం రాసిన రిక్వెస్ట్ అదనపు ఫీల్డ్ వల్ల విఫలం కాదు.
• తప్పు JSON రకం ఉన్న తెలిసిన ఫీల్డ్‌కు, లేదా తప్పనిసరి ఫీల్డ్ లేనప్పుడు 422 తో సమాధానం వస్తుంది. చెల్లుబాటు కాని JSON బాడీకి 400 తో సమాధానం వస్తుంది.
• model అనేది Models & pricing లోని ids లో ఒకటి. పెద్ద మరియు చిన్న అక్షరాలు పట్టింపు కాదు.

సమాధానం JSON, లేదా రిక్వెస్ట్ stream ను true కి సెట్ చేసినప్పుడు server-sent events స్ట్రీమ్. ప్రతి ఎండ్‌పాయింట్ తన సొంత ఫార్మాట్‌లో సమాధానం ఇస్తుంది. ప్రతి సమాధానంలో x-request-id హెడర్ ఉంటుంది.

రిక్వెస్ట్ దాటే తనిఖీలు

మోడల్ నడిచే ముందు రిక్వెస్ట్ నిర్ణీత క్రమంలో తనిఖీ చేయబడుతుంది. విఫలమైన మొదటి తనిఖీ సమాధానం ఇస్తుంది, కాబట్టి 401 బాడీ గురించి ఇంకా ఏమీ చెప్పదు.

ఎరర్ ఆకృతి

ఎరర్ అనేది type మరియు message ఉన్న error కలిగిన JSON ఆబ్జెక్ట్. /v1/messages దాన్ని Anthropic SDK లు ఆశించే విధంగా చుడుతుంది; మిగతా ప్రతి path 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) రిజర్వ్ చేస్తుంది, ఆపై అది నిజంగా ఉపయోగించిన tokens కు మోడల్ ధరతో ఛార్జ్ చేయబడుతుంది.
• ప్రతి సమాధానం తన tokens లెక్కలను usage లో నివేదిస్తుంది. Keys & usage పేజీ బ్యాలెన్స్‌ను మరియు ప్రతి రిక్వెస్ట్ ఎంత ఖర్చైందో చూపిస్తుంది.
• ప్రతి రిక్వెస్ట్‌కు సమానంగా సేవ అందుతుంది. రిక్వెస్ట్ రేటుపై ఉన్న ఏకైక పరిమితి flood protection: ఖాతాకు నిమిషానికి 120 రిక్వెస్ట్‌లు. సమాంతరంగా పంపిన రిక్వెస్ట్‌లు వరుసలో వేచి ఉంటాయి.

పరిమితులు మరియు బ్యాలెన్స్ మోడల్స్ & ధరలు Keys & usage

మోడల్‌పై ఆధారపడే ఫీల్డ్‌లు

ప్రతి మోడల్ ఒకే రిక్వెస్ట్‌ను తీసుకుంటుంది. కొన్ని ఫీల్డ్‌లు కొన్ని మోడల్స్‌లో మాత్రమే ప్రభావం చూపుతాయి; పట్టిక ఎక్కడో పేర్కొంటుంది. ఎండ్‌పాయింట్ పేజీలు ప్రతి ఫీల్డ్‌ను జాబితా చేస్తాయి.

Chat Completions

OpenAI SDK నుండి వస్తున్నప్పుడు

• బేస్ URL ను https://api.shannon-ai.com/v1 కి మరియు కీని మీ Shannon కీకి సెట్ చేయండి. అప్పుడు Chat Completions మరియు Responses కాల్స్ SDK తో ఉన్నట్లే పనిచేస్తాయి.
• model తప్పనిసరిగా Shannon id అయి ఉండాలి. gpt-4o వంటి మరో ప్రొవైడర్ మోడల్ పేరుకు 400 మరియు unknown model తో సమాధానం వస్తుంది.
• రీజనింగ్ ప్రత్యేక ఫీల్డ్‌లో వస్తుంది: మెసేజ్‌లో మరియు స్ట్రీమ్ డెల్టాలలో content పక్కన reasoning_content.
• స్ట్రీమ్ ఎల్లప్పుడూ తన చివరి చంక్‌లో finish_reason తో పాటు usage ను కలిగి ఉంటుంది.
• స్ట్రీమ్‌లో టూల్ కాల్ పూర్తి arguments string ఉన్న ఒక చంక్‌గా వస్తుంది.
• సమాధానంలో ఒక choice ఉంటుంది.
• /v1/embeddings వంటి పై పట్టికలో లేని OpenAI API path లకు 404 తో సమాధానం వస్తుంది.

Anthropic SDK నుండి వస్తున్నప్పుడు

• బేస్ URL ను /v1 లేకుండా https://api.shannon-ai.com కి, కీని మీ 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": {…}}.

ఈ ఫార్మాట్‌లు మాట్లాడే కోడింగ్ టూల్స్ అదే విధంగా సెటప్ చేయబడతాయి: బేస్ URL, కీ, మరియు మోడల్‌గా ఒక Shannon id. CLI కోడింగ్ టూల్స్