Àwọn àwòrán àti fáìlì
Fi àwọn àwòrán ránṣẹ́ pẹ̀lú ìfiránṣẹ́: àwọn model tó ń gbà wọ́n, àwọn ọ̀nà tí a gbà àti àwọn ààlà wọn.
POST https://api.shannon-ai.com/v1/chat/completions
Àwòrán ń rìn nínú ìfiránṣẹ́ user, bí apá kan content rẹ̀. Àpẹẹrẹ náà ń ka fáìlì lórí ẹ̀rọ rẹ, ó sì ń fi ránṣẹ́ bí 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
}
} Àwọn model tó ń gba àwòrán
| Àwọn model | Ó ń ka |
|---|---|
shannon-3, shannon-3-pro, shannon-3.1, shannon-3.1-pro | Àwọn àwòrán, àti àwọn ìwé: PDF, Word, PowerPoint, Excel àti àwọn fáìlì ọ̀rọ̀ lásán. |
shannon-1.6-lite, shannon-1.6-pro | Àwọn àwòrán. |
shannon-2-lite, shannon-2-pro | Àwọn àwòrán, nínú àwọn ìbéèrè tó tún fi tools tàbí response_format ránṣẹ́. |
Kimi-K3-3BIT-REAP, MiniMax-M3-3BIT-REAP, Kimi-K2.6-W4A16-AUTOROUND-REAP, inkling-W4A16-AUTOROUND-REAP, MiMo-V2.5-W8A16 | Àwọn àwòrán. |
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 | Ọ̀rọ̀. A ń fi status 400 dá ìbéèrè pẹ̀lú àwòrán lóhùn. |
shannon-coder-1 | Ọ̀rọ̀. |
GET /v1/models ń ròyìn input àwòrán fún id kọ̀ọ̀kan bí capabilities.vision. Àwọn model àti iye owó
- Àwọn model Shannon ń ka àwọn fáìlì ti ìfiránṣẹ́ user tó gbẹ̀yìn. Fi àwòrán sínú ìfiránṣẹ́ tó ń béèrè nípa rẹ̀.
- Ìdílé Shannon 3 tún ń pa àwọn àwòrán àti ìwé díẹ̀ ti àwọn ìfiránṣẹ́ user tẹ́lẹ̀ mọ́ ní ojú nígbà tí a bá fi wọ́n ránṣẹ́ nínú ìbéèrè, ó sì ń ka iye àwòrán tó pọ̀ jù tí a ṣètò fún ìbéèrè kan, tí a ń kà láti èyí àkọ́kọ́.
- Àwọn model open-weight tí a gbàlejò ń ka àwọn àwòrán ti gbogbo ìfiránṣẹ́ inú ìjíròrò.
Àwọn ọ̀nà tí a gbà
A ń fi fáìlì ránṣẹ́ lọ́nà méjì: nínú ìbéèrè bí base64, tàbí bí àdírẹ́sì tí API ń mú wá. Fáìlì kọ̀ọ̀kan ń rìn pẹ̀lú ìbéèrè náà; API kò ní endpoint upload.
| Endpoint | Nínú ìbéèrè (base64) | Nípasẹ̀ àdírẹ́sì |
|---|---|---|
/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://…"}} |
Ìfiránṣẹ́ user kan náà ní ọ̀nà kọ̀ọ̀kan:
{
"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 ní ìrísí
data:<media type>;base64,<data>. Apá;base64jẹ́ dandan. - Lórí
/v1/chat/completionsàti/v1/responses,image_urllè jẹ́ string fúnra rẹ̀ tàbí object{"url": "…"}. - Irú fáìlì wá láti data URL tàbí láti
media_type. Láìsí i, a ń ka àwòrán bíimage/png. - Àwọn fáìlì inú ìbéèrè ń ṣe kún ìwọ̀n body ìbéèrè, tó lè tó 32 MiB.
- A gbà fún ìbáramu:
image_url.detail.
Àwọn ààlà fún àwọn fáìlì jíjìnnà
Nígbà tí o bá fi àdírẹ́sì ránṣẹ́, API ń mú fáìlì náà wá kí model tó ṣiṣẹ́, láàrín àwọn ààlà wọ̀nyí:
| Ààlà | Òfin |
|---|---|
| Ìwọ̀n | Títí dé 8 MiB fún fáìlì kọ̀ọ̀kan. |
| Àkókò | Ìṣẹ́jú-àáyá 20 láti dáhùn. |
| Àwọn redirect | 5 ni púpọ̀ jù. |
| Àdírẹ́sì | http:// tàbí https://, láìsí orúkọ user tàbí ọ̀rọ̀ aṣínà nínú àdírẹ́sì, lórí host tó ní àdírẹ́sì gbangba. |
| Èsì host | Status láàrín ẹgbẹ́ 200 àti body tí kò ṣófo. A ń ka irú fáìlì láti Content-Type. |
| A béèrè bí | User-Agent: ShannonBot/1.0 (+https://shannon-ai.com) |
Bí a ṣe ń ka àwọn àwòrán ní token
Lórí àwọn model open-weight tí a gbàlejò, àwòrán ń ka token kan fún patch pixel 28 × 28 kọ̀ọ̀kan: fífẹ̀ tí a pín sí 28, tí a yí sókè, ní ìgbà gígùn tí a pín sí 28, tí a yí sókè. Abajade jẹ́ apá usage.prompt_tokens, a sì ń gba owó rẹ̀ bí input.
- 1024 × 1024
- 1,369 token
- 1920 × 1080
- 2,691 token
- 512 × 512
- 361 token
- A kọ́kọ́ mú àwòrán jíjìnnà wá, nítorí náà a ń ka ìwọ̀n gidi rẹ̀.
- Àwòrán tí a kò lè ka ìwọ̀n rẹ̀ ń ka token 1,024.
- Àwọn endpoint ìkà ń lo òfin kan náà fún data URL. Wọn kì í mú àdírẹ́sì jíjìnnà wá, wọ́n sì ń kà á bí token 1,024. Kíka token
- Fún model Shannon, ka iye tí ìbéèrè pẹ̀lú àwọn àwòrán ná láti
usagenínú èsì.
Àwọn ìwé àti àwọn fáìlì mìíràn
Ìdílé Shannon 3 (shannon-3, shannon-3-pro, shannon-3.1, shannon-3.1-pro) ń ka àwọn ìwé pẹ̀lú. A ń yọ ọ̀rọ̀ ìwé náà jáde, a sì ń fún model pẹ̀lú ìfiránṣẹ́ rẹ.
| Ìwé | Irú media |
|---|---|
application/pdf | |
| Word | application/vnd.openxmlformats-officedocument.wordprocessingml.document |
| PowerPoint | application/vnd.openxmlformats-officedocument.presentationml.presentation |
| Excel | application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
Ìwé jẹ́ apá ìfiránṣẹ́ user, bí àwòrán:
| Endpoint | Nínú ìbéèrè (base64) | Nípasẹ̀ àdírẹ́sì |
|---|---|---|
/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."}
]
}
]
} - Fún un ní irú media gidi ti fáìlì náà. Láìsí i, a ń ka ìwé bí
application/pdf. - Fáìlì ọ̀rọ̀ lásán, bíi CSV, ni a ń kà bí ọ̀rọ̀ tí a sì so mọ́ ní ọ̀nà kan náà.
- Nígbà tí a kò lè ka ìwé, tàbí fáìlì náà jẹ́ irú mìíràn, a sọ fún model, ó sì lè sọ ọ́ nínú ìdáhùn rẹ̀. Status ṣì jẹ́
200. - Lórí gbogbo model mìíràn, a fi apá ìwé sílẹ̀ kúrò nínú ohun tí model ń kà, a sì dáhùn ìbéèrè láti ìyókù.
- Ìwé tí a fi ránṣẹ́ nípasẹ̀ àdírẹ́sì ni a ń mú wá lábẹ́ àwọn ààlà fún àwọn fáìlì jíjìnnà lókè.
Àwọn àṣìṣe
| Ipò | Irú | Ìfiránṣẹ́ | Nígbà wo |
|---|---|---|---|
400 | invalid_request_error | <id> does not accept image input | A fi àwòrán ránṣẹ́ sí model open-weight tí a gbàlejò tó ń gba ọ̀rọ̀ nìkan. A kò yọ nǹkankan láti balance rẹ. |
400 | invalid_request_error | audio and video input are not supported by any hosted model | A fi apá audio tàbí fídíò ránṣẹ́ sí model open-weight tí a gbàlejò. |
413 | invalid_request_error | Failed to buffer the request body: … | Body ìbéèrè, pẹ̀lú àwọn fáìlì inú rẹ̀, tóbi ju 32 MiB. Àṣìṣe náà gbé code: "request_too_large". |
Model Shannon ń dáhùn pẹ̀lú status 200 ohun yòówù fáìlì tí ìbéèrè gbé: apá tí kò bá kà ni a fi sílẹ̀. Mimu Aṣiṣe