Chat Completions

POST https://api.shannon-ai.com/v1/chat/completions

Το μικρότερο αίτημα είναι ένα id μοντέλου και ένα μήνυμα χρήστη.

from openai import OpenAI

client = OpenAI(
    api_key="YOUR_API_KEY",
    base_url="https://api.shannon-ai.com/v1",
)

response = client.chat.completions.create(
    model="shannon-3",
    messages=[{"role": "user", "content": "Say hello in one sentence."}],
)

print(response.choices[0].message.content)

import OpenAI from "openai";

const client = new OpenAI({
  apiKey: "YOUR_API_KEY",
  baseURL: "https://api.shannon-ai.com/v1",
});

const response = await client.chat.completions.create({
  model: "shannon-3",
  messages: [{ role: "user", content: "Say hello in one sentence." }],
});

console.log(response.choices[0].message.content);

curl https://api.shannon-ai.com/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "shannon-3",
    "messages": [{"role": "user", "content": "Say hello in one sentence."}]
  }'

Η απάντηση είναι ένα αντικείμενο JSON:

{
  "id": "chatcmpl-5f0c1e7a9b3d4c62a8e1f07d2b46c9a3",
  "object": "chat.completion",
  "created": 1791625200,
  "model": "shannon-3",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "Hello, it is good to meet you.",
        "reasoning_content": "The user wants a greeting in one sentence. Keep it short and friendly."
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 1184,
    "completion_tokens": 46,
    "total_tokens": 1230
  }
}

Κεφαλίδες

Κεφαλίδες αιτήματος

Κεφαλίδες απάντησης

Πεδία αιτήματος

Μόνο το messages είναι υποχρεωτικό. Η στήλη Εφαρμόζεται από ονομάζει τα μοντέλα στα οποία ένα πεδίο αλλάζει την απάντηση. Τα φιλοξενούμενα μοντέλα ανοιχτών βαρών είναι τα δώδεκα ids της λίστας μοντέλων· η οικογένεια Shannon 3 είναι τα shannon-3, shannon-3-pro, shannon-3.1 και shannon-3.1-pro. Μοντέλα & τιμές

Άλλα πεδία του OpenAI, όπως n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store και prompt_cache_key, γίνονται δεκτά ώστε ο υπάρχων κώδικας client να τρέχει αμετάβλητος. Δεν αλλάζουν την απάντηση: υπάρχει πάντα μία επιλογή και ένα stream τελειώνει πάντα με χρήση.

Ένα πεδίο με λάθος τύπο JSON, για παράδειγμα "max_tokens": "100", επιστρέφει 422. Το ίδιο ισχύει για αίτημα χωρίς messages.

Τα εργαλεία, η δομημένη έξοδος, ο συλλογισμός και η αναζήτηση στον ιστό έχουν η καθεμία τη δική της σελίδα: Κλήση συναρτήσεων, Δομημένες έξοδοι, Προσπάθεια συλλογισμού, Ενσωματωμένη αναζήτηση ιστού.

Ένα αίτημα με επιλογές

Αυτό το αίτημα ορίζει ένα μήνυμα system, τα πεδία δειγματοληψίας και την προσπάθεια συλλογισμού. Χρησιμοποιεί φιλοξενούμενο μοντέλο ανοιχτών βαρών, το οποίο τα εφαρμόζει όλα.

from openai import OpenAI

client = OpenAI(
    api_key="YOUR_API_KEY",
    base_url="https://api.shannon-ai.com/v1",
)

response = client.chat.completions.create(
    model="DeepSeek-V4-Flash-0731-W4A16-AUTOROUND-REAP",
    messages=[
        {"role": "system", "content": "You are a physics teacher. Answer in two sentences."},
        {"role": "user", "content": "Why is the sky blue?"},
    ],
    max_tokens=512,
    temperature=0.3,
    top_p=0.9,
    seed=7,
    stop=["\n\n"],
    reasoning_effort="low",
)

message = response.choices[0].message
print(message.reasoning_content)  # the reasoning
print(message.content)            # the answer
print(response.usage)

import OpenAI from "openai";

const client = new OpenAI({
  apiKey: "YOUR_API_KEY",
  baseURL: "https://api.shannon-ai.com/v1",
});

const response = await client.chat.completions.create({
  model: "DeepSeek-V4-Flash-0731-W4A16-AUTOROUND-REAP",
  messages: [
    { role: "system", content: "You are a physics teacher. Answer in two sentences." },
    { role: "user", content: "Why is the sky blue?" },
  ],
  max_tokens: 512,
  temperature: 0.3,
  top_p: 0.9,
  seed: 7,
  stop: ["\n\n"],
  reasoning_effort: "low",
});

const message = response.choices[0].message;
console.log(message.reasoning_content); // the reasoning
console.log(message.content);           // the answer
console.log(response.usage);

curl https://api.shannon-ai.com/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "DeepSeek-V4-Flash-0731-W4A16-AUTOROUND-REAP",
    "messages": [
      {"role": "system", "content": "You are a physics teacher. Answer in two sentences."},
      {"role": "user", "content": "Why is the sky blue?"}
    ],
    "max_tokens": 512,
    "temperature": 0.3,
    "top_p": 0.9,
    "seed": 7,
    "stop": ["\n\n"],
    "reasoning_effort": "low"
  }'

Η απάντηση έχει την ίδια μορφή με την παραπάνω. Το usage της προσθέτει δύο λεπτομέρειες στα φιλοξενούμενα μοντέλα ανοιχτών βαρών: τα tokens prompt που διαβάστηκαν από το cache και τα tokens που δαπανήθηκαν στον συλλογισμό.

{
  "usage": {
    "prompt_tokens": 31,
    "completion_tokens": 62,
    "total_tokens": 93,
    "prompt_tokens_details": {
      "cached_tokens": 0
    },
    "completion_tokens_details": {
      "reasoning_tokens": 21
    }
  }
}

Μήκος εξόδου

Το max_tokens κάνει δύο πράγματα. Πρώτον, είναι ο αριθμός των tokens που δεσμεύονται από το υπόλοιπό σας όταν ξεκινά το αίτημα. Όταν ολοκληρωθεί η απάντηση, το ποσό αυτό αντικαθίσταται από τα tokens που χρησιμοποίησε το αίτημα. Αν το max_tokens είναι μεγαλύτερο από όσο απομένει στο υπόλοιπό σας, το αίτημα επιστρέφει 429 Quota exceeded ακόμη κι αν η ίδια η απάντηση θα χωρούσε. Στείλτε χαμηλότερο max_tokens για να δεσμευτεί λιγότερο.

Το shannon-coder-1 μετριέται διαφορετικά σε αυτό το endpoint: κάθε αίτημα είναι μία από τις κλήσεις Shannon Coder του πλάνου σας και δεν δεσμεύονται tokens γι' αυτό. Όρια και υπόλοιπο

Δεύτερον, περιορίζει το μήκος της απάντησης σε αυτά τα μοντέλα:

Χωρίς max_tokens ή max_completion_tokens, η τιμή είναι 4,096. Στο shannon-coder-1 είναι 65,536.

Μηνύματα

Κάθε μήνυμα είναι αντικείμενο με role και content. Το content είναι string ή πίνακας από μέρη όταν το μήνυμα φέρει περισσότερα από κείμενο.

Με id της οικογένειας Shannon 3, βάλτε τις οδηγίες που πρέπει να ισχύουν στο μήνυμα user.

Στα επίπεδα Shannon ένα αίτημα χωρίς κείμενο χρήστη και χωρίς tools επιστρέφει 400 No user message provided.

Μέρη περιεχομένου

Τα μεγέθη, τα όρια και ο πλήρης κατάλογος μορφών έχουν τη δική τους σελίδα. Εικόνες και αρχεία

Το αντικείμενο απάντησης

Λόγοι ολοκλήρωσης

Μια απάντηση χωρίς streaming αναφέρει stop ή tool_calls.

Χρήση

Στα φιλοξενούμενα μοντέλα ανοιχτών βαρών, το prompt_tokens είναι τα μηνύματά σας και οι ορισμοί εργαλείων μετρημένα με το δικό του tokenizer του μοντέλου, συν τα tokens τυχόν εικόνων. Τα endpoints μέτρησης tokens επιστρέφουν τον ίδιο αριθμό πριν στείλετε. Καταμέτρηση tokens

Στα επίπεδα Shannon, το prompt_tokens μετρά ό,τι διάβασε το μοντέλο για να γράψει την απάντηση, οπότε είναι μεγαλύτερο από το κείμενο των μηνυμάτων σας μόνο.

Streaming

Με το stream ορισμένο σε true, η απάντηση φτάνει ως συμβάντα chat.completion.chunk και τελειώνει με data: [DONE]. Το τελευταίο chunk πριν από αυτό φέρει finish_reason και usage· δεν χρειάζονται stream_options. Οι μορφές των chunks, οι γραμμές keep-alive και τα σφάλματα μέσα σε stream έχουν τη δική τους σελίδα. Ροή

Σφάλματα

Ένα σφάλμα είναι αντικείμενο JSON με μέλος error. Οι έλεγχοι εκτελούνται με αυτή τη σειρά: κλειδί API, σώμα αιτήματος, id μοντέλου και μετά υπόλοιπο. Ο πίνακας απαριθμεί όσα επιστρέφει πιο συχνά αυτό το endpoint. Ο πλήρης κατάλογος, με το τι να δοκιμάσετε ξανά, έχει τη δική του σελίδα. Χειρισμός σφαλμάτων

{
  "error": {
    "type": "invalid_request_error",
    "message": "unknown model: no-such-model"
  }
}