Yfirlit

Endapunktar

Allir endapunktar eru undir einu base URL og eru þjónaðir yfir HTTPS.

https://api.shannon-ai.com

Endapunktarnir þrír sem búa til texta ná til sömu líkana. Veldu þann sem kóðinn þinn notar þegar sniðið á.

Grunnatriði beiðna

• Meginmál hverrar POST er einn JSON-hlutur, allt að 32 MiB.
• Reitur sem API þekkir ekki veldur engri villu og hefur engin áhrif. Beiðni sem skrifuð er fyrir annan þjónustuaðila mistekst ekki vegna aukareits.
• Þekktum reit með röngu JSON-gagnatagi, eða nauðsynlegum reit sem vantar, er svarað með 422. Meginmáli sem er ekki gilt JSON er svarað með 400.
• model er eitt af auðkennunum á Líkön og verð. Há- og lágstafir skipta ekki máli.

Svar er JSON, eða straumur af server-sent events þegar beiðnin stillir stream á true. Hver endapunktur svarar á sínu eigin sniði. Hvert svar hefur hausinn x-request-id.

Það sem beiðni fer í gegnum

Beiðni er athuguð í fastri röð áður en líkan keyrir. Fyrsta athugunin sem mistekst svarar, svo 401 segir þér ekkert enn um meginmálið.

Form villu

Villa er JSON-hlutur með error sem geymir type og message. /v1/messages vefur hana eins og Anthropic SDK búast við; allar aðrar slóðir nota OpenAI-formið.

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

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

• Lestu type og message. code og param eru aðeins til staðar á sumum villum: líttu á þau sem valfrjáls. param er alltaf null.
• Eftir að straumur er hafinn er staðan þegar 200. Bilun berst þá sem villurammi inni í straumnum.
• Hvert villusvar ber hausinn x-request-id.

Villumeðhöndlun

Greiðslur og staða

• Það er ein staða á reikning, og spjall og API deila henni: fyrst dagleg úthlutun áskriftarinnar í dag, síðan keypt inneign. API hefur engan eigin kvóta.
• Beiðni tekur frá úttaksáætlun sína (max_tokens, sjálfgefið 4,096) og er síðan gjaldfærð fyrir táknin sem hún notaði í raun, á verði líkansins.
• Hvert svar skráir táknatölur sínar í usage. Síðan Lyklar og notkun sýnir stöðuna og hvað hver beiðni kostaði.
• Hver beiðni er afgreidd jafnt. Einu mörkin á beiðnahraða eru flóðvörn: 120 beiðnir á mínútu á reikning. Beiðnir sem eru sendar samhliða bíða í röð.

Mörk og staða Líkön og verð Lyklar og notkun

Reitir sem fara eftir líkani

Öll líkön taka við sömu beiðni. Nokkrir reitir hafa áhrif á sumum líkönum eingöngu; taflan nefnir hvar. Endapunktasíðurnar telja upp alla reiti.

Chat Completions

Ef þú kemur frá OpenAI SDK

• Stilltu base URL á https://api.shannon-ai.com/v1 og lykilinn á Shannon-lykilinn þinn. Chat Completions og Responses köll virka þá með SDK eins og það er.
• model verður að vera Shannon-auðkenni. Líkanheiti annars þjónustuaðila, svo sem gpt-4o, er svarað með 400 og unknown model.
• Rökhugsun kemur í sérstökum reit: reasoning_content við hlið content, bæði í skilaboðunum og í straumdeltum.
• Straumur ber alltaf usage í síðasta bútnum, ásamt finish_reason.
• Tólakall í streymi berst sem einn búttur með allan arguments strenginn.
• Svar hefur eitt val.
• Slóðum OpenAI API sem eru ekki í töflunni hér að ofan, svo sem /v1/embeddings, er svarað með 404.

Ef þú kemur frá Anthropic SDK

• Stilltu base URL á https://api.shannon-ai.com, án /v1, og lykilinn á Shannon-lykilinn þinn. SDK sendir hann sem x-api-key.
• model verður að vera Shannon-auðkenni.
• max_tokens er valfrjálst á þessu API. Sjálfgefið gildi þess er 4,096.
• Svar geymir efnisblokkir af gerðunum thinking, text og tool_use. Fyrsta blokkin er ekki alltaf textinn: veldu blokkir eftir type.
• stop_reason er end_turn eða tool_use. Straumur frá Shannon-líkani getur einnig endað með max_tokens.
• anthropic-version og anthropic-beta eru samþykkt, svo SDK virkar óbreytt. Beiðni þarf þau ekki.
• Villur á /v1/messages hafa Anthropic-formið: {"type": "error", "error": {…}}.

Forritunartól sem tala þessi snið eru sett upp á sama hátt: base URL, lykill og Shannon-auðkenni sem líkan. CLI-forritunartól