API Playground

Interaktif

هەموو مۆدێل و endpoint ێک لە وێبگەڕەکەدا بە کلیلی خۆت تاقی بکەرەوە — دەرچووی streaming و پشکنەری داواکاری و کۆدی دروستکراو کە ڕاستەوخۆ دەتوانیت بیخەیتە ناو ئەپەکەتەوە.

کردنەوەی Playground

Playground کۆنسۆڵێکی chat ـە بۆ API لە /docs/playground. لەگەڵ مۆدێلێک قسە دەکەیت، و playground هەمان ئەو داواکارییانە دەنێرێت کە کۆدەکەت دەینێرێت: بۆ یەکێک لە سێ endpoint ـەکە، لەگەڵ ئەو مۆدێل، system prompt، پارامەتر و ئامرازانەی تۆ دایدەنێیت. هەر داواکارییەک دەکرێت وەک کۆد و وەک ڕووداوی stream ی خاو بخوێنرێتەوە.

دەستپێکردن

کلیلێکی پێ بدە — کاتێک چووییتە ژوورەوە، playground کلیلی API ی هەژمارەکەت بەکاردەهێنێت و باڵانسەکەت نیشان دەدات. ئەگەر نەچوویتە ژوورەوە، زیادکردنی کلیل هەڵبژێرە و کلیلێک paste بکە: تەنها لەم tab ـەدا دەمێنێتەوە و هەرگیز پاشەکەوت ناکرێت.
endpoint و مۆدێلێک هەڵبژێرە — هێڵی سەرەوە گۆڕەری endpoint و هەڵبژێری مۆدێل هەڵدەگرێت. گفتوگۆیەکی نوێ لەسەر Chat Completions دەست پێدەکات لەگەڵ shannon-3.
نامەیەک بنێرە — لە خوارەوە بنووسە و Enter دابگرە. هەر وەڵامێک دەبێتە بەشێک لە گفتوگۆکە، بۆیە نامەی دواتر بەردەوامی دەکات. شاشە بەتاڵەکە سێ prompt ی دەستپێک و نموونەیەکی ئامادەی بانگکردنی ئامراز پێشکەش دەکات.

کلیلەکەت لە لاپەڕەی Keys & usage دەدۆزیتەوە و دەیگۆڕیت. Keys & usage

Endpoint و مۆدێلەکان

گۆڕەری endpoint بڕیار دەدات playground کام فۆرماتی داواکاری دروست بکات. دەتوانیت لە ناوەڕاستی گفتوگۆیەکدا بیگۆڕیت؛ نامەکان دەمێننەوە.

Endpoint	ئەو داواکارییەی دەینێرێت	ڕیفرانس
Chat Completions	`POST /v1/chat/completions`	Chat Completions
Responses	`POST /v1/responses`	Responses API
Messages	`POST /v1/messages`	Anthropic

هەڵبژێری مۆدێل ئەوە لیست دەکات کە GET /v1/models دەیگەڕێنێتەوە. دەتوانرێت تێیدا بگەڕێیت، مۆدێلە نوێکانت لە سەرەوە دەهێڵێتەوە، و بۆ هەر مۆدێلێک نرخ بۆ هەر 1M تۆکن، context window و نیشانەکانی ئامراز، input ی وێنە، بیرکردنەوە و output ی structured نیشان دەدات.

گفتوگۆکە

وەڵامەکان لەکاتی نووسینیاندا لەناو گفتوگۆکە stream دەکرێن. بیرکردنەوەی مۆدێلەکە لە بلۆکێکی تایبەتی خۆیدا نیشان دەدرێت کە دەتوانیت بیتەوێنیت.
لە ژێر هەر وەڵامێک: کات تا یەکەم تۆکن، تۆکن لە چرکەیەکدا، کاتی تێپەڕبوو، تۆکنی input و output لەگەڵ بەشە کەشراو و بیرکردنەوە ەکان، مەزەندەی تێچووی نۆرەکە، هۆکاری کۆتاییهاتن و id ی وەڵام.
نامەیەکی خۆت دەکرێت دەستکاری بکرێت و لەو شوێنەوە دووبارە بنێردرێت. وەڵامێک دەکرێت دووبارە دروست بکرێتەوە. نامەیەک دەکرێت بسڕدرێتەوە، و سڕینەوەکە بۆ چەند چرکەیەک دەکرێت هەڵبوەشێندرێتەوە.
وەستان یان کلیلی Esc وەڵامێک کە دەنووسرێت کۆتایی پێدەهێنێت.
وێنە بە دوگمەی وێنە، بە paste یان بە دانانی فایلێک هاوپێچ دەکرێن، بۆ ئەو مۆدێلانەی وێنە وەردەگرن. وێنەیەک پێش ناردن بۆ 1,568 پیکسڵ لەسەر لای درێژەکەی بچووک دەکرێتەوە. فایلێک لە 30 MB زیاتر نادیدە دەگیرێت.
composer و system prompt ژمارەی تۆکن نیشان دەدەن. بۆ مۆدێلە open-weight ـە میوانداریکراوەکان ئەو ژمارە وردەیە کە لە POST /v1/tokenize دێت. بۆ مۆدێلەکانی دیکە مەزەندەیە، بە ≈ نیشان کراوە.
داواکارییەکی شکستخواردوو نیشان دەدات دواتر چی بکرێت: کلیلێک دابنێ کاتێک کلیلەکە ڕەت کرایەوە، کرێدیت زیاد بکە کاتێک باڵانس تەواو بووە، ژمارەی چرکەکانی چاوەڕێکردن دوای داواکاری زۆر، یان هەوڵدانەوە دوای هەڵەی سێرڤەر.

ڕێکخستنەکانی داواکاری

دوگمەی ڕێکخستنەکان پانێلێک دەکاتەوە بە شەش tab. ڕێکخستنەکان سەر بە گفتوگۆن: هەر گفتوگۆیەک هی خۆی هەڵدەگرێت.

Tab	چی هەڵدەگرێت
System	system prompt ی گفتوگۆکە، لەگەڵ هەر داواکارییەک دەنێردرێت. پێنج قاڵب پڕی دەکەنەوە، و ژمارەی تۆکنەکانی نیشان دەدرێت.
پارامەترەکان	زۆرینەی تۆکنی output، temperature، `top_p`، ئاستی بیرکردنەوە، ڕیزبەندی وەستان، `seed`، و گۆڕەرەکانی streaming و گەڕانی وێب. کۆنترۆڵێک کە endpoint ی هەڵبژێردراو بوارێکی بۆی نییە کوژاوەتەوە و نیشان کراوە.
ئامرازەکان	پێناسەی ئامرازەکان کە لەگەڵ داواکارییەکە دەنێردرێن: چوار preset (`get_weather`، `read_file`، `run_shell`، `web_search`) یان پێناسەی خۆت وەک JSON، و `tool_choice` (`auto`، `none`، `required` یان یەک ئامراز بە ناو). کاتێک مۆدێلەکە ئامرازێک بانگ دەکات، گفتوگۆکە بانگکردنەکە نیشان دەدات لەگەڵ خانەیەک بۆ ئەنجامەکە. کاتێک پێشکەشکردنی ئەنجامی نموونە کراوەیە، یەک کلیک ئەنجامێکی نموونە پڕ دەکاتەوە. دەشتوانیت ئەنجامی خۆت بنووسیت، پاشان بینێریت بۆ بەردەوامبوونی نۆرەکە.
Structured	`response_format`: `text`، `json_object` یان `json_schema` لەگەڵ ناوی schema و schema ی JSON. کاتێک schema دانراوە، دوایین وەڵام بەراورد دەکرێت لەگەڵی و لە گفتوگۆکەدا نیشان دەکرێت کە دەگونجێت یان نا. ئەم tab ە لەسەر endpoint ی Messages کوژاوەتەوە، و بژاردەیەک کە مۆدێلی هەڵبژێردراو وەریناگرێت پێشکەش ناکرێت.
کۆد	داواکاری گفتوگۆی ئێستا وەک کۆدی cURL، Python، Node یان Go، لە گفتوگۆکە و ڕێکخستنەکانی دروست کراوە. کلیلەکە وەک `YOUR_API_KEY` چاپ دەکرێت. کۆدەکە دەکرێت کۆپی بکرێت یان لە بینینێکی گەورەدا بکرێتەوە.
ڕووداوەکان	دوایین نۆرە وەک بەسەر تۆڕدا ڕۆیشتووە: هەموو ڕووداوێکی stream لەگەڵ کاتی دوورکەوتنەوەی و فلتەرێک، وەڵامی کۆکراوە، headers ی وەڵام (`x-request-id`، `content-type`، `retry-after`، `date`) و body ی داواکاری. ئەمانە تا دووبارە بارکردنەوەی لاپەڕەکە دەمێننەوە.

پشکنینی input

ئەو بەهایانەی دەینووسیت پێش ناردنی داواکارییەک دەپشکنرێن. بەهایەک لە دەرەوەی ڕێژە لە بوارەکەی دا نیشان دەکرێت، و ناردن ڕادەگیرێت تا ڕاست دەکرێتەوە.

ڕێکخستن	پشکنین
زۆرینەی تۆکنی output	ژمارەیەکی تەواو لە 1 تا `max_output_tokens` ی مۆدێلەکە.
Temperature	ژمارەیەک لە 0 تا 2. بەتاڵ بوارەکە لە داواکارییەکە دەردەهێنێت.
`top_p`	ژمارەیەک لە 0 تا 1. بەتاڵ بوارەکە لە داواکارییەکە دەردەهێنێت.
`seed`	ژمارەیەکی تەواو.
ڕیزبەندی وەستان	زۆرینە 4، بە کۆما جیا کراون.
`response_format`	دەبێت یەکێک بێت کە مۆدێلی هەڵبژێردراو وەریدەگرێت. گفتوگۆیەک کە گوازرابێتەوە بۆ مۆدێلێک بەبێ `json_schema` یان بەبێ `response_format` لەگەڵ هۆکارەکە ڕادەگیرێت.
وێنەکان	کاتێک دەگۆڕیت بۆ مۆدێلێک کە تەنها دەق وەردەگرێت، لە نامەکە لادەبرێن، لەگەڵ تێبینییەک.

بەراوردکردنی دوو مۆدێل

بەراوردکردنی دوو مۆدێل لە مێنیووی زیاتر هەڵبژێرێکی دووەمی مۆدێل زیاد دەکات. ئەو کات هەر نامەیەک بۆ هەردوو مۆدێلەکە دەچێت لە یەک کاتدا، بە هەمان ڕێکخستن، و دوو وەڵامەکە لەتەنیشت یەک دەوەستن، بە A و B نیشان کراون. دەتوانیت یەک لا بە تەنها دووبارە دروست بکەیتەوە. کاتێک لایەک ئامرازێک بانگ دەکات، ئەو ئەنجامەی دەینێریت تەنها ئەو لایە بەردەوام دەکات.

کۆپیکردنی لینکی هاوبەشکردن گفتوگۆکە دەخاتە ناو خودی لینکەکە، لەو بەشەی دوای #. هیچ شتێک بار ناکرێت. وێنەکان، کلیلەکەت و وردەکارییەکانی دوایین جار لێ دەردەهێنرێن. هەرکەسێک لینکەکە دەکاتەوە گفتوگۆکە وەک گفتوگۆیەکی نوێ لە playground ی خۆیدا وەردەگرێت.
گفتوگۆیەک کە بۆ لینکێک زۆر درێژە لەگەڵ تێبینییەک ڕەت دەکرێتەوە. لەبری ئەوە وەک JSON داینەگرە.
داگرتنی JSON ی گفتوگۆ گفتوگۆکە لەگەڵ ڕێکخستنەکانی وەک فایلێک پاشەکەوت دەکات. هاوردەکردنی JSON لە پانێلی گفتوگۆکان فایلێکی وا دەکاتەوە.
کۆپیکردن وەک cURL داواکاری ئێستا وەک یەک فەرمانی cURL کۆپی دەکات.

چی لە کوێ دەمێنێتەوە

چی	لە کوێ دەمێنێتەوە
گفتوگۆکان، ئامرازە پاشەکەوتکراوەکان، مۆدێلە نوێکان، ڕێکخستنی پانێلەکان	لەم وێبگەڕەدا. بۆ Shannon نانێردرێن و لەگەڵ تۆ بۆ ئامێرێکی دیکە ناگوازرێنەوە.
کلیلی API	لە بیرگەی tab ی کراوەدا. کلیلێکی paste کراو کاتێک لاپەڕەکە دووبارە بار دەکرێتەوە یان tab ەکە دادەخرێت دەڕۆن. کاتێک چووییتە ژوورەوە، کلیلەکە هەر جارێک لە هەژمارەکەتەوە دەخوێنرێتەوە.
ڕووداوەکانی stream، headers و داواکاری دوایین نۆرە	لەناو لاپەڕە کراوەکەدا، تا دووبارە بار دەکرێتەوە.
داواکارییەکان	لە وێبگەڕەکەتەوە بۆ API دەنێردرێن بە کلیلەکەت. وەک هەر داواکارییەکی دیکەی API لەسەر باڵانسەکەت هەژمار دەکرێن.

کیبۆرد

دوگمەکان	چی دەکات
`Enter`	نامەکە بنێرە.
`Shift` + `Enter`	هێڵێکی نوێ دەست پێبکە.
`Ctrl` + `K`	command palette بکەرەوە: endpoint یان مۆدێل بگۆڕە، قاڵبێکی system دابنێ، گفتوگۆیەکی نوێ دەست پێبکە، streaming، ئامراز یان بەراوردکردن بگۆڕە. لەسەر Mac: ⌘ K.
`Esc`	ئەو وەڵامە ڕابگرە کە دەنووسرێت، یان پانێلێکی کراوە دابخە لەسەر شاشەی تەنگ.