وێنە و فایلەکان
وێنە لەگەڵ نامەیەک بنێرە: کام مۆدێل وەریدەگرن، شێوازە وەرگیراوەکان و سنوورەکانیان.
POST https://api.shannon-ai.com/v1/chat/completions
وێنەیەک لەناو نامەی بەکارهێنەردا دەگەڕێت، وەک یەک بەشی content ـەکەی. نموونەکە فایلێکی ناوخۆیی دەخوێنێتەوە و وەک data URL دەینێرێت.
import base64
from openai import OpenAI
client = OpenAI(api_key="YOUR_API_KEY", base_url="https://api.shannon-ai.com/v1")
with open("photo.jpg", "rb") as f:
image = base64.b64encode(f.read()).decode()
response = client.chat.completions.create(
model="shannon-3",
messages=[{
"role": "user",
"content": [
{"type": "text", "text": "What is in this picture?"},
{"type": "image_url", "image_url": {"url": "data:image/jpeg;base64," + image}},
],
}],
)
print(response.choices[0].message.content) import fs from "node:fs";
import OpenAI from "openai";
const client = new OpenAI({ apiKey: "YOUR_API_KEY", baseURL: "https://api.shannon-ai.com/v1" });
const image = fs.readFileSync("photo.jpg").toString("base64");
const response = await client.chat.completions.create({
model: "shannon-3",
messages: [{
role: "user",
content: [
{ type: "text", text: "What is in this picture?" },
{ type: "image_url", image_url: { url: "data:image/jpeg;base64," + image } },
],
}],
});
console.log(response.choices[0].message.content); # Linux: base64 -w0 photo.jpg macOS: base64 -i photo.jpg
IMAGE=$(base64 -w0 photo.jpg)
curl https://api.shannon-ai.com/v1/chat/completions \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d @- <<EOF
{
"model": "shannon-3",
"messages": [{
"role": "user",
"content": [
{"type": "text", "text": "What is in this picture?"},
{"type": "image_url", "image_url": {"url": "data:image/jpeg;base64,${IMAGE}"}}
]
}]
}
EOF {
"id": "chatcmpl-8d1f3a5c7e9b4d2f6a8c0e2b4d6f8a1c",
"object": "chat.completion",
"created": 1791590400,
"model": "shannon-3",
"choices": [
{
"index": 0,
"message": {
"role": "assistant",
"content": "A grey cat asleep on a windowsill, with a potted fern beside it.",
"reasoning_content": null
},
"finish_reason": "stop"
}
],
"usage": {
"prompt_tokens": 286,
"completion_tokens": 19,
"total_tokens": 305
}
} کام مۆدێل وێنە وەردەگرن
| مۆدێلەکان | دەیخوێنێتەوە |
|---|---|
shannon-3, shannon-3-pro, shannon-3.1, shannon-3.1-pro | وێنە، و بەڵگەنامە: PDF، Word، PowerPoint، Excel و فایلەکانی دەقی سادە. |
shannon-1.6-lite, shannon-1.6-pro | وێنە. |
shannon-2-lite, shannon-2-pro | وێنە، لە داواکارییەکاندا کە tools یان response_format یش دەنێرن. |
Kimi-K3-3BIT-REAP, MiniMax-M3-3BIT-REAP, Kimi-K2.6-W4A16-AUTOROUND-REAP, inkling-W4A16-AUTOROUND-REAP, MiMo-V2.5-W8A16 | وێنە. |
DeepSeek-V4-Pro-0813-3BIT-REAP, GLM-5.2-3BIT-REAP, Nemotron3Ultra-3BIT-REAP, DeepSeek-V4-Flash-0731-W4A16-AUTOROUND-REAP, Laguna-S-2.1-W4A16-AUTOROUND-REAP, MiMo-V2.5-Pro-W8A16, Hy3-W8A16 | دەق. داواکارییەک لەگەڵ وێنە بە status ی 400 وەڵام دەدرێتەوە. |
shannon-coder-1 | دەق. |
GET /v1/models input ی وێنە بۆ هەر id ێک وەک capabilities.vision ڕاپۆرت دەکات. مۆدێل و نرخ
- مۆدێلەکانی Shannon فایلەکانی دوایین نامەی بەکارهێنەر دەخوێننەوە. وێنەکە لەو نامەیەدا دابنێ کە دەربارەی ئەو دەپرسێت.
- بنەماڵەی Shannon 3 هەروەها چەند وێنە و بەڵگەنامەیەکی نامە پێشووەکانی بەکارهێنەر لەبەرچاو دەهێڵێتەوە کاتێک ناوەکی نێردرابن، و زۆرینەیەکی دیاریکراوی وێنە بۆ هەر داواکارییەک دەخوێنێتەوە، لە یەکەمەوە هەژمار دەکرێت.
- مۆدێلە open-weight ـە میوانداریکراوەکان وێنەی هەموو نامەیەکی گفتوگۆکە دەخوێننەوە.
شێوازە وەرگیراوەکان
فایل بە یەکێک لە دوو ڕێگا دەنێردرێت: لەناو داواکارییەکەدا وەک base64، یان وەک ناونیشانێک کە API دەیهێنێت. هەموو فایلێک لەگەڵ داواکارییەکە دەگەڕێت؛ API endpoint ی بارکردنی نییە.
| Endpoint | لەناو داواکاری (base64) | بە ناونیشان |
|---|---|---|
/v1/chat/completions | {"type": "image_url", "image_url": {"url": "data:image/jpeg;base64,…"}} | {"type": "image_url", "image_url": {"url": "https://…"}} |
/v1/responses | {"type": "input_image", "image_url": "data:image/jpeg;base64,…"} | {"type": "input_image", "image_url": "https://…"} |
/v1/messages | {"type": "image", "source": {"type": "base64", "media_type": "image/jpeg", "data": "…"}} | {"type": "image", "source": {"type": "url", "url": "https://…"}} |
هەمان نامەی بەکارهێنەر لە هەر فۆرماتێکدا:
{
"role": "user",
"content": [
{"type": "text", "text": "What is in this picture?"},
{
"type": "image_url",
"image_url": {
"url": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD…"
}
}
]
} {
"role": "user",
"content": [
{"type": "input_text", "text": "What is in this picture?"},
{
"type": "input_image",
"image_url": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD…"
}
]
} {
"role": "user",
"content": [
{"type": "text", "text": "What is in this picture?"},
{
"type": "image",
"source": {
"type": "base64",
"media_type": "image/jpeg",
"data": "/9j/4AAQSkZJRgABAQAAAQABAAD…"
}
}
]
} - data URL ئەم شێوەیەی هەیە
data:<media type>;base64,<data>. بەشی;base64پێویستە. - لەسەر
/v1/chat/completionsو/v1/responses،image_urlدەتوانێت خودی string ەکە بێت یان ئۆبجێکتی{"url": "…"}. - جۆری فایلەکە لە data URL یان لە
media_typeوەردەگیرێت. بەبێ یەکێک، وێنە وەکimage/pngدەخوێنرێتەوە. - فایلە ناوەکییەکان لە قەبارەی body ی داواکارییەکەدا هەژمار دەکرێن، کە دەتوانێت تا 32 MiB بێت.
- بۆ گونجاوی وەردەگیرێت:
image_url.detail.
سنوورەکانی فایلی دوور
کاتێک ناونیشانێک دەنێریت، API فایلەکە دەهێنێت پێش ئەوەی مۆدێلەکە کار بکات، لەناو ئەم سنوورانەدا:
| سنوور | یاسا |
|---|---|
| قەبارە | تا 8 MiB بۆ هەر فایلێک. |
| کات | 20 چرکە بۆ وەڵامدانەوە. |
| Redirectـەکان | زۆرینە 5. |
| ناونیشان | http:// یان https://، بەبێ ناوی بەکارهێنەر یان وشەی نهێنی لە ناونیشانەکەدا، لەسەر hostێک بە ناونیشانی گشتی. |
| وەڵامی host | status ێک لە ڕێژەی 200 و body ێک کە بەتاڵ نەبێت. جۆری فایلەکە لە Content-Type دەخوێنرێتەوە. |
| داوا دەکرێت وەک | User-Agent: ShannonBot/1.0 (+https://shannon-ai.com) |
وێنە چۆن بە تۆکن هەژمار دەکرێن
لەسەر مۆدێلە open-weight ـە میوانداریکراوەکان وێنەیەک بۆ هەر پارچەیەکی 28 × 28 پیکسڵ یەک تۆکن هەژمار دەکرێت: پانی دابەشکراو بەسەر 28 ی بەرزکراوە، لێکدراو لە بەرزی دابەشکراو بەسەر 28 ی بەرزکراوە. ئەنجامەکە بەشێکە لە usage.prompt_tokens و وەک input نرخ دەگیرێت.
- 1024 × 1024
- 1,369 تۆکن
- 1920 × 1080
- 2,691 تۆکن
- 512 × 512
- 361 تۆکن
- وێنەی دوور سەرەتا دەهێنرێت، بۆیە قەبارە ڕاستەقینەکەی هەژمار دەکرێت.
- وێنەیەک کە قەبارەکەی ناخوێنرێتەوە 1,024 تۆکن هەژمار دەکرێت.
- endpoint ـەکانی هەژمارکردن هەمان یاسا بۆ data URL ـەکان بەکاردەهێنن. ناونیشانی دوور ناهێنن و وەک 1,024 تۆکن هەژماری دەکەن. هەژمارکردنی تۆکن
- بۆ مۆدێلی Shannon، نرخی داواکارییەک لەگەڵ وێنە لە
usageی وەڵامەکە بخوێنەرەوە.
بەڵگەنامە و فایلەکانی دیکە
بنەماڵەی Shannon 3 (shannon-3, shannon-3-pro, shannon-3.1, shannon-3.1-pro) بەڵگەنامەش دەخوێنێتەوە. دەقی بەڵگەنامەکە دەردەهێنرێت و لەگەڵ نامەکەت دەدرێتە مۆدێلەکە.
| بەڵگەنامە | جۆری میدیا |
|---|---|
application/pdf | |
| Word | application/vnd.openxmlformats-officedocument.wordprocessingml.document |
| PowerPoint | application/vnd.openxmlformats-officedocument.presentationml.presentation |
| Excel | application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
بەڵگەنامە بەشێکە لە نامەی بەکارهێنەر، وەک وێنە:
| Endpoint | لەناو داواکاری (base64) | بە ناونیشان |
|---|---|---|
/v1/chat/completions, /v1/messages | {"type": "document", "source": {"type": "base64", "media_type": "application/pdf", "data": "…"}} | {"type": "document", "source": {"type": "url", "url": "https://…"}} |
/v1/responses | {"type": "input_file", "file_data": "data:application/pdf;base64,…"} | {"type": "input_file", "file_url": "https://…"} |
{
"model": "shannon-3",
"messages": [
{
"role": "user",
"content": [
{
"type": "document",
"source": {
"type": "base64",
"media_type": "application/pdf",
"data": "JVBERi0xLjcKJeLjz9MK…"
}
},
{"type": "text", "text": "Summarise this report in five points."}
]
}
]
} {
"model": "shannon-3",
"input": [
{
"role": "user",
"content": [
{
"type": "input_file",
"file_data": "data:application/pdf;base64,JVBERi0xLjcKJeLjz9MK…"
},
{
"type": "input_text",
"text": "Summarise this report in five points."
}
]
}
]
} {
"model": "shannon-3",
"messages": [
{
"role": "user",
"content": [
{
"type": "document",
"source": {
"type": "base64",
"media_type": "application/pdf",
"data": "JVBERi0xLjcKJeLjz9MK…"
}
},
{"type": "text", "text": "Summarise this report in five points."}
]
}
]
} - جۆری ڕاستەقینەی میدیای فایلەکە بدە. بەبێ یەکێک، بەڵگەنامە وەک
application/pdfدەخوێنرێتەوە. - فایلی دەقی سادە، وەک CSV، وەک دەق دەخوێنرێتەوە و بە هەمان شێوە هاوپێچ دەکرێت.
- کاتێک بەڵگەنامەیەک ناخوێنرێتەوە، یان فایلەکە جۆرێکی دیکەیە، بە مۆدێلەکە دەوترێت و دەتوانێت لە وەڵامەکەیدا بیڵێت. status هێشتا
200ە. - لەسەر هەموو مۆدێلێکی دیکە بەشی بەڵگەنامە لەو شتە دەردەهێنرێت کە مۆدێلەکە دەیخوێنێتەوە، و داواکارییەکە لە ماوەکەی دیکەوە وەڵام دەدرێتەوە.
- بەڵگەنامەیەک کە بە ناونیشان نێردرابێت لەژێر سنوورەکانی فایلی دوور دەهێنرێت کە لە سەرەوەن.
هەڵەکان
| دۆخ | جۆر | پەیام | کەی |
|---|---|---|---|
400 | invalid_request_error | <id> does not accept image input | وێنەیەک بۆ مۆدێلێکی open-weight ی میوانداریکراو نێردرا کە تەنها دەق وەردەگرێت. هیچ شتێک لە باڵانسەکەت ناگیرێت. |
400 | invalid_request_error | audio and video input are not supported by any hosted model | بەشێکی دەنگ یان ڤیدیۆ بۆ مۆدێلێکی open-weight ی میوانداریکراو نێردرا. |
413 | invalid_request_error | Failed to buffer the request body: … | body ی داواکارییەکە، لەگەڵ فایلە ناوەکییەکانی، لە 32 MiB گەورەترە. هەڵەکە code: "request_too_large" هەڵدەگرێت. |
مۆدێلێکی Shannon بە status ی 200 وەڵام دەداتەوە هەر فایلێک داواکارییەکە هەڵیبگرێت: بەشێک کە نایخوێنێتەوە دەردەهێنرێت. Çewtî