Ogige API
MmekọrịtaNwale model na endpoint ọ bụla na browser site na key nke gị — streaming output, request inspector, na koodu emepụtara ị nwere ike itinye ozugbo n'ngwa gị.
Playground bụ chat console maka API na /docs/playground. Ị na-agwa model okwu, playground na-ezipukwa otu requests koodu gị ga-ezipu: gaa n'otu n'endpoints atọ, na model, system prompt, parameters na tools i tọrọ. A pụrụ ịgụghachi request ọ bụla dị ka koodu na dị ka raw stream events.
Mmalite
- Nye ya key — Mgbe ị banyere, playground na-eji API key nke akaụntụ gị ma na-egosi balance gị. Mgbe ị na-abanyeghị, họrọ Add key ma tinye key: a na-edebe ya na tab a naanị ma anaghị echekwa ya.
- Họrọ endpoint na model — Bar dị n'elu nwere endpoint switch na model picker. Mkparịta ụka ọhụrụ na-amalite na Chat Completions na
shannon-3. - Zipụ ozi — Dee n'okpuru ma pịa Enter. Azịza ọ bụla na-abanye n'mkparịta ụka, ya mere ozi na-esote na-aga n'ihu. Ihuenyo efu na-enye starter prompts atọ na ihe atụ tool-call dị njikere.
Ị na-ahụ ma gbanwee key gị na peeji Keys & usage. Keys & usage
Endpoints na models
Endpoint switch na-ekpebi request format playground na-ewu. Ị nwere ike ịgbanwe ya n'etiti mkparịta ụka; ozi ndị ahụ na-anọgide.
| Endpoint | Request ọ na-ezipu | Ntụaka |
|---|---|---|
| Chat Completions | POST /v1/chat/completions | Chat Completions |
| Responses | POST /v1/responses | Responses API |
| Messages | POST /v1/messages | Anthropic |
Model picker na-depụta ihe GET /v1/models na-eweghachi. A pụrụ ịchọ ya, ọ na-edebe models gị ndị ọhụrụ n'elu, ma na-egosi maka model ọ bụla ọnụahịa kwa tokens 1M, context window na akara maka tools, image input, reasoning na structured output.
Mkparịta ụka
- Azịza na-asọba n'thread ka a na-ede ha. A na-egosi reasoning nke model n'block nke ya ị nwere ike ịpịkọta.
- N'okpuru azịza ọ bụla: oge ruo token mbụ, tokens kwa sekọnd, oge gafere, input na output tokens na akụkụ cached na reasoning, atụmatụ nke ọnụahịa turn, finish reason na response id.
- Enwere ike idezi ma zighachi ozi gị site n'ebe ahụ. Enwere ike ịmaliteghachi azịza. Enwere ike ihichapụ ozi, a pụkwara ịmepụta mkpochapụ ahụ ọzọ ruo sekọnd ole na ole.
- Stop ma ọ bụ igodo Esc na-akwụsị azịza a na-ede.
- A na-agbakwunye images site na image button, site na ịtinye ma ọ bụ ịdọrọ file, maka models na-anara images. A na-eme ka image bụrụ pixel 1,568 n'ọnụ ogologo ya tupu e zipụ ya. A na-ahapụ file karịrị 30 MB.
- Composer na system prompt na-egosi ọnụọgụ tokens. Maka hosted open-weight models ọ bụ ọnụọgụ ziri ezi site na
POST /v1/tokenize. Maka models ndị ọzọ ọ bụ atụmatụ, akara≈. - Request dara na-egosi ihe a ga-eme ọzọ: tọọ key mgbe a jụrụ key, top up mgbe ejiri balance, sekọnd a ga-eche mgbe requests dị ukwuu gafere, ma ọ bụ nnwale ọzọ mgbe njehie server.
Request settings
Bọtịnụ Settings na-emepe panel nwere tabs isii. Settings bụ nke mkparịta ụka: mkparịta ụka ọ bụla na-edebe nke ya.
| Tab | Ihe ọ nwere |
|---|---|
| System | System prompt nke mkparịta ụka, e zipụrụ na request ọ bụla. Templates ise na-ejuputa ya, a na-egosikwa ọnụọgụ tokens ya. |
| Parameters | Max output tokens, temperature, top_p, reasoning effort, stop sequences, seed, na switches maka streaming na web search. A na-emechi ma kaa control endpoint ahọpụtara enweghị field maka ya. |
| Tools | Tool definitions e zipụrụ na request: presets anọ (get_weather, read_file, run_shell, web_search) ma ọ bụ nkọwa nke gị dị ka JSON, na tool_choice (auto, none, required ma ọ bụ otu tool site na aha). Mgbe model na-akpọ tool, thread na-egosi call ahụ na igbe maka result. Site na Offer sample results na-agba, otu pịa na-ejuputa sample result. Ị nwekwara ike ide nke gị, wee zipụ ya ka turn gaa n'ihu. |
| Structured | response_format: text, json_object ma ọ bụ json_schema nwere schema name na JSON schema. Mgbe tọrọ schema, a na-elele azịza ikpeazụ megide ya ma kaa ya na thread dị ka ọ kwekọrọ ma ọ bụ ọ kwekọghị. A na-emechi tab na Messages endpoint, a naghịkwa enye nhọrọ model ahọpụtara anaghị anara. |
| Koodu | Request nke mkparịta ụka dị ugbu a dị ka koodu cURL, Python, Node ma ọ bụ Go, e wuru site na mkparịta ụka na settings ya. A na-ebipụta key dị ka YOUR_API_KEY. A pụrụ ịkọpị koodu ma ọ bụ mepee ya n'nnukwu ọhụhụ. |
| Events | Turn ikpeazụ dị ka o si gafee waya: stream event ọ bụla na time offset ya na filter, azịza e chịkọtara, reply headers (x-request-id, content-type, retry-after, date) na request body. A na-edebe ha ruo mgbe peeji na-ebugharị. |
Nlele input
A na-elele uru ị na-ede tupu e zipụ request. A na-akaa uru dị n'èzí oke na field ya, a na-egbochikwa izipu ruo mgbe edoziri ya.
| Setting | Nlele |
|---|---|
| Max output tokens | Ọnụọgụ zuru ezu site na 1 ruo max_output_tokens nke model. |
| Temperature | Ọnụọgụ site na 0 ruo 2. Efu na-ahapụ field ahụ n'ime request. |
top_p | Ọnụọgụ site na 0 ruo 1. Efu na-ahapụ field ahụ n'ime request. |
seed | Ọnụọgụ zuru ezu. |
| Stop sequences | 4 kacha, kewapụrụ site na commas. |
response_format | Ga-abụ nke model ahọpụtara na-anara. A na-egbochi mkparịta ụka e kwagara na model na-enweghị json_schema ma ọ bụ na-enweghị response_format, ya na ihe kpatara ya. |
| Images | A na-ewepụ ya n'ozi mgbe ị gbanwere gaa model na-anara text naanị, ya na ihe ndetu. |
Tụnyere models abụọ
Compare two models n'menu More na-agbakwunye model picker nke abụọ. Ozi ọ bụla mgbe ahụ na-aga na models abụọ n'otu oge, na otu settings, azịza abụọ ahụ na-anọkọ n'akụkụ, akara A na B. Ị nwere ike ịmaliteghachi otu akụkụ naanị. Mgbe otu akụkụ na-akpọ tool, result ị zipụrụ na-aga n'ihu na akụkụ ahụ naanị.
Kekọrịta, export na import
- Copy share link na-ejikọta mkparịta ụka n'ime link n'onwe ya, n'akụkụ dị mgbe
#. A naghị ebuga ihe ọ bụla. A na-ahapụ images, key gị na nkọwa nke ọgba ikpeazụ. Onye meghere link na-enweta mkparịta ụka ahụ dị ka nke ọhụrụ na playground nke ya. - A na-ajụ mkparịta ụka toro ogologo maka link, ya na ihe ndetu. Download ya dị ka JSON kama.
- Download conversation JSON na-echekwa mkparịta ụka ya na settings ya dị ka file. Import JSON na conversations panel na-emepe file dị otú ahụ.
- Copy as cURL na-akọpị request dị ugbu a dị ka otu cURL command.
Ihe a na-edebe ebe
| Gịnị | Ebe a na-edebe ya |
|---|---|
| Mkparịta ụka, tools echekwara, models ọhụrụ, panel layout | Na browser a. A naghị ezipu ha na Shannon ha anaghịkwa eso gị gaa ngwaọrụ ọzọ. |
| API key | Na memory nke tab meghere. Key etinyere agwụla mgbe peeji na-ebugharị ma ọ bụ tab emechie. Mgbe ị banyere, a na-agụ key site na akaụntụ gị mgbe ọ bụla. |
| Stream events, headers na request nke turn ikpeazụ | Na peeji meghere, ruo mgbe ọ na-ebugharị ọzọ. |
| Requests | A na-ezipu ha site na browser gị gaa API na key gị. A na-agụ ha megide balance gị dị ka request API ọ bụla ọzọ. |
Keyboard
| Keys | Ihe ọ na-eme |
|---|---|
Enter | Zipụ ozi ahụ. |
Shift + Enter | Malite ahịrị ọhụrụ. |
Ctrl + K | Mepee command palette: gbanwee endpoint ma ọ bụ model, tọọ system template, malite mkparịta ụka ọhụrụ, gbanwee streaming, tools ma ọ bụ compare. Na Mac: ⌘ K. |
Esc | Kwụsị azịza a na-ede, ma ọ bụ mechie panel meghere na ihuenyo warara. |