Shannon AI API-dokumentaatio

Yleiskatsaus

Julkiset asiakirjat

Kaikki mitä tarvitset Shannonin OpenAI- ja Anthropic-yhteensopivan API:n kanssa.

Perus-URL-osoite OpenAI-yhteensopiva

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

Käytä Chat Completions API:ta toimintokutsujen ja suoratoiston kanssa.

Perus-URL-osoite Anthropic-yhteensopiva

https://api.shannon-ai.com/v1/messages

Claude Messages -muoto työkaluilla ja antrooppisen version otsikolla.

Otsikot Todennus

Valtuutus: Kantaja <oma-avaimesi>

Tai X-API-Key antropisella versiolla Claude-tyylisiin puheluihin.

Pääsy Tila

Julkiset asiakirjat - Avain vaaditaan soittamiseen

Suoratoisto, toimintokutsu, strukturoidut lähdöt, verkkohaku.

Käynnistä tarkistuslista

+

Osoita SDK:si Shannoniin

Aseta baseURL yllä oleviin OpenAI- tai Anthropic-päätepisteisiin.

Asennus
+

Liitä API-avain

Käytä Bearer-tunnuksia OpenAI-kutsuihin tai X-API-Key + anthropic-versioon.

Turvallisuus
+

Ota työkalut ja strukturoidut tulosteet käyttöön

Tukee OpenAI-työkaluja/toimintoja, JSON-skeemaa ja sisäänrakennettua web_hakua.

Ominaisuudet
+

Raidan käyttö

Tarkastele tunnuksen ja haun kulutusta tällä sivulla, kun olet kirjautunut tilillesi.

Analytics

Ominaisuudet

OpenAI + Anthropic

Drop-in-korvaus OpenAI- ja Anthropic-sovellusliittymille, jossa on natiivi tuki työkaluille, strukturoidut tulosteet ja sisäänrakennettu verkkohaku.

Drop-in vaihto

Yhteensopiva

Toimii OpenAI:n ja Anthropic SDK:iden kanssa. Vaihda vain perus-URL-osoite.

Toiminto kutsu

Työkalut

Määrittele työkalut, anna Shannonin kutsua niitä. Tukee automaattista, pakotettua ja ei mitään -tiloja.

Sisäänrakennettu verkkohaku

Etsi

Reaaliaikainen verkkohaku lähdeviittauksilla. Automaattisesti saatavilla.

Strukturoidut lähdöt

JSON

JSON-tila ja JSON Schema-valvonta luotettavaa tietojen poimimista varten.

Monikierrostyökalut

Agentti

Automaattiset toimintojen suoritussilmukat. Jopa 10 iteraatiota per pyyntö.

Suoratoisto

Nopeasti

Palvelimen lähettämät tapahtumat reaaliaikaista merkkien suoratoistoa varten.

Pika-aloitus

5 minuuttia

Aloita kolmessa vaiheessa. Shannon peilaa OpenAI- ja Anthropic-asiakkaita.

Aseta perus-URL-osoite

Käytä OpenAI-yhteensopivaa päätepistettä.

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

Lisää API-avain

Käytä Valtuutus-otsikossa siirtotietodennusta.

Lähetä ensimmäinen viestisi

Valitse kieli ja vaihda avaimesi.

Python

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-1.6-lite",
    messages=[
        {"role": "system", "content": "You are a helpful assistant."},
        {"role": "user", "content": "Hello, Shannon!"}
    ],
    max_tokens=1024
)

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

JavaScript

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-1.6-lite',
  messages: [
    { role: 'system', content: 'You are a helpful assistant.' },
    { role: 'user', content: 'Hello, Shannon!' }
  ],
  max_tokens: 1024
});

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

package main

import (
    "context"
    "fmt"
    openai "github.com/sashabaranov/go-openai"
)

func main() {
    config := openai.DefaultConfig("YOUR_API_KEY")
    config.BaseURL = "https://api.shannon-ai.com/v1"
    client := openai.NewClientWithConfig(config)

    resp, err := client.CreateChatCompletion(
        context.Background(),
        openai.ChatCompletionRequest{
            Model: "shannon-1.6-lite",
            Messages: []openai.ChatCompletionMessage{
                {Role: "system", Content: "You are a helpful assistant."},
                {Role: "user", Content: "Hello, Shannon!"},
            },
            MaxTokens: 1024,
        },
    )
    if err != nil {
        panic(err)
    }
    fmt.Println(resp.Choices[0].Message.Content)
}

cURL

curl -X POST "https://api.shannon-ai.com/v1/chat/completions" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "shannon-1.6-lite",
    "messages": [
      {"role": "system", "content": "You are a helpful assistant."},
      {"role": "user", "content": "Hello, Shannon!"}
    ],
    "max_tokens": 1024
  }'

Vastauksen muoto

Menestysvastaus

{
  "id": "chatcmpl-abc123",
  "object": "chat.completion",
  "created": 1234567890,
  "model": "Shannon 1.6 Lite",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "Hello! I'm Shannon, your AI assistant. How can I help you today?"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 25,
    "completion_tokens": 18,
    "total_tokens": 43
  }
}

API Playground

Uusi

Testaa Shannon API suoraan selaimessasi. Rakenna pyyntösi, suorita se ja katso vastaus reaaliajassa.

Chat, Responses, Messages

Switch across OpenAI Chat Completions, Responses, and Anthropic Messages without leaving the playground.

Stream live output

Run real requests, inspect raw JSON, and view stream events from the same operator console.

Reuse your key

Signed-in users can pull their Shannon API key straight into the dedicated playground workspace.

/fi/docs/playground

The playground now lives on its own route so the API docs stay Astro-rendered while the request builder remains an explicitly interactive client tool.

Kokeile Playgroundia V2 Hanki API-avain

Todennus

Kaikki API-pyynnöt vaativat todennuksen Shannon API -avaimella.

OpenAI-muoto (suositus)

HTTP

Authorization: Bearer YOUR_API_KEY

Antrooppinen muoto

HTTP

X-API-Key: YOUR_API_KEY
anthropic-version: 2023-06-01

Mallit

Shannon tarjoaa useita malleja, jotka on optimoitu erilaisiin käyttötarkoituksiin.

shannon-1.6-lite Shannon 1.6 Lite

Nopeat ja tehokkaat vastaukset jokapäiväisiin tehtäviin

Konteksti 128K

Paras Chat, Q&A, sisällön luominen

shannon-1.6-pro Shannon 1.6 Pro

Kehittynyt perustelu monimutkaisiin ongelmiin

Konteksti 128K

Paras Analyysi, tutkimus, monimutkaiset tehtävät

shannon-2-lite Shannon 2 Lite

Konteksti 128K

Paras

shannon-2-pro Shannon 2 Pro

Konteksti 128K

Paras

shannon-coder-1 Shannon Coder

Optimoitu Claude Code CLI:lle puhelupohjaisella kiintiöllä

Konteksti 128K

Paras Koodin luominen, työkalujen käyttö, CLI-integrointi

Puhelupohjainen kiintiö

Toiminto kutsu

Määritä työkalut, joita Shannon voi käyttää toimintojen suorittamiseen tai tietojen hakemiseen.

Python

from openai import OpenAI
import json

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

# Define available tools/functions
tools = [
    {
        "type": "function",
        "function": {
            "name": "get_weather",
            "description": "Get current weather for a location",
            "parameters": {
                "type": "object",
                "properties": {
                    "location": {
                        "type": "string",
                        "description": "City name, e.g., 'Tokyo'"
                    },
                    "unit": {
                        "type": "string",
                        "enum": ["celsius", "fahrenheit"]
                    }
                },
                "required": ["location"]
            }
        }
    }
]

response = client.chat.completions.create(
    model="shannon-1.6-lite",
    messages=[{"role": "user", "content": "What's the weather in Tokyo?"}],
    tools=tools,
    tool_choice="auto"
)

# Check if model wants to call a function
if response.choices[0].message.tool_calls:
    tool_call = response.choices[0].message.tool_calls[0]
    print(f"Function: {tool_call.function.name}")
    print(f"Arguments: {tool_call.function.arguments}")

JavaScript

import OpenAI from 'openai';

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

const tools = [
  {
    type: 'function',
    function: {
      name: 'get_weather',
      description: 'Get current weather for a location',
      parameters: {
        type: 'object',
        properties: {
          location: { type: 'string', description: "City name" },
          unit: { type: 'string', enum: ['celsius', 'fahrenheit'] }
        },
        required: ['location']
      }
    }
  }
];

const response = await client.chat.completions.create({
  model: 'shannon-1.6-lite',
  messages: [{ role: 'user', content: "What's the weather in Tokyo?" }],
  tools,
  tool_choice: 'auto'
});

if (response.choices[0].message.tool_calls) {
  const toolCall = response.choices[0].message.tool_calls[0];
  console.log('Function:', toolCall.function.name);
  console.log('Arguments:', toolCall.function.arguments);
}

Työkalun valintavaihtoehdot

"auto" Malli päättää, kutsutaanko funktiota (oletus)

"none" Poista tämän pyynnön kutsuminen käytöstä

{"type": "function", "function": {"name": "..."}} Pakota tietty funktiokutsu

Toiminto Call Response

Kun malli kutsuu funktiota

{
  "id": "chatcmpl-xyz",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": null,
        "tool_calls": [
          {
            "id": "call_abc123",
            "type": "function",
            "function": {
              "name": "get_weather",
              "arguments": "{\"location\": \"Tokyo\", \"unit\": \"celsius\"}"
            }
          }
        ]
      },
      "finish_reason": "tool_calls"
    }
  ]
}

Strukturoidut lähdöt

Pakota Shannon vastaamaan kelvollisella JSON-koodilla, joka vastaa malliasi.

Python

from openai import OpenAI

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

# Force JSON output with schema
response = client.chat.completions.create(
    model="shannon-1.6-lite",
    messages=[
        {"role": "user", "content": "Extract: John Doe, 30 years old, engineer"}
    ],
    response_format={
        "type": "json_schema",
        "json_schema": {
            "name": "person_info",
            "schema": {
                "type": "object",
                "properties": {
                    "name": {"type": "string"},
                    "age": {"type": "integer"},
                    "occupation": {"type": "string"}
                },
                "required": ["name", "age", "occupation"]
            }
        }
    }
)

import json
data = json.loads(response.choices[0].message.content)
print(data)  # {"name": "John Doe", "age": 30, "occupation": "engineer"}

JavaScript

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-1.6-lite',
  messages: [
    { role: 'user', content: 'Extract: John Doe, 30 years old, engineer' }
  ],
  response_format: {
    type: 'json_schema',
    json_schema: {
      name: 'person_info',
      schema: {
        type: 'object',
        properties: {
          name: { type: 'string' },
          age: { type: 'integer' },
          occupation: { type: 'string' }
        },
        required: ['name', 'age', 'occupation']
      }
    }
  }
});

const data = JSON.parse(response.choices[0].message.content);
console.log(data); // { name: "John Doe", age: 30, occupation: "engineer" }

Vastausmuotovaihtoehdot

{"type": "json_object"} Pakota kelvollinen JSON -tulostus (ei tiettyä mallia)

{"type": "json_schema", "json_schema": {...}} Pakota tulos, joka vastaa tarkkaa malliasi

Suoratoisto

Ota reaaliaikainen tunnuksen suoratoisto käyttöön palvelimen lähettämien tapahtumien avulla reagoiville käyttöliittymille.

Python

from openai import OpenAI

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

# Enable streaming for real-time responses
stream = client.chat.completions.create(
    model="shannon-1.6-lite",
    messages=[
        {"role": "user", "content": "Write a short poem about AI"}
    ],
    stream=True
)

for chunk in stream:
    if chunk.choices[0].delta.content:
        print(chunk.choices[0].delta.content, end="", flush=True)

JavaScript

import OpenAI from 'openai';

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

// Enable streaming for real-time responses
const stream = await client.chat.completions.create({
  model: 'shannon-1.6-lite',
  messages: [
    { role: 'user', content: 'Write a short poem about AI' }
  ],
  stream: true
});

for await (const chunk of stream) {
  const content = chunk.choices[0]?.delta?.content;
  if (content) process.stdout.write(content);
}

Vinkki: Suoratoistovastaukset saapuvat palvelimen lähettämänä tapahtumana. Jokainen pala sisältää delta osittaisella sisällöllä.

Sisäänrakennettu verkkohaku

Shannon sisältää sisäänrakennetun web_search-toiminnon, joka on automaattisesti käytettävissä.

Python

from openai import OpenAI

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

# Web search is automatically available!
# Shannon will use it when needed for current information

response = client.chat.completions.create(
    model="shannon-1.6-lite",
    messages=[
        {"role": "user", "content": "What are the latest AI news today?"}
    ],
    # Optionally, explicitly define web_search tool
    tools=[{
        "type": "function",
        "function": {
            "name": "web_search",
            "description": "Search the web for current information",
            "parameters": {
                "type": "object",
                "properties": {
                    "query": {"type": "string", "description": "Search query"}
                },
                "required": ["query"]
            }
        }
    }]
)

print(response.choices[0].message.content)
# Response includes sources and citations

JavaScript

import OpenAI from 'openai';

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

// Web search is automatically available!
// Shannon will use it when needed for current information

const response = await client.chat.completions.create({
  model: 'shannon-1.6-lite',
  messages: [
    { role: 'user', content: 'What are the latest AI news today?' }
  ],
  // Optionally, explicitly define web_search tool
  tools: [{
    type: 'function',
    function: {
      name: 'web_search',
      description: 'Search the web for current information',
      parameters: {
        type: 'object',
        properties: {
          query: { type: 'string', description: 'Search query' }
        },
        required: ['query']
      }
    }
  }]
});

console.log(response.choices[0].message.content);
// Response includes sources and citations

Provinkki: Verkkohakutuloksissa on viittauksia. Shannon mainitsee lähteet automaattisesti.

Antrooppinen muoto

Shannon tukee myös Anthropic's Messages API -muotoa.

https://api.shannon-ai.com/v1/messages

Python

import anthropic

client = anthropic.Anthropic(
    api_key="YOUR_API_KEY",
    base_url="https://api.shannon-ai.com/messages"
)

response = client.messages.create(
    model="shannon-1.6-lite",
    max_tokens=1024,
    messages=[
        {"role": "user", "content": "Hello, Shannon!"}
    ],
    # Tool use (Anthropic format)
    tools=[{
        "name": "web_search",
        "description": "Search the web",
        "input_schema": {
            "type": "object",
            "properties": {
                "query": {"type": "string"}
            },
            "required": ["query"]
        }
    }]
)

print(response.content[0].text)

JavaScript

import Anthropic from '@anthropic-ai/sdk';

const client = new Anthropic({
  apiKey: 'YOUR_API_KEY',
  baseURL: 'https://api.shannon-ai.com/messages'
});

const response = await client.messages.create({
  model: 'shannon-1.6-lite',
  max_tokens: 1024,
  messages: [
    { role: 'user', content: 'Hello, Shannon!' }
  ],
  // Tool use (Anthropic format)
  tools: [{
    name: 'web_search',
    description: 'Search the web',
    input_schema: {
      type: 'object',
      properties: {
        query: { type: 'string' }
      },
      required: ['query']
    }
  }]
});

console.log(response.content[0].text);

Pakollinen otsikko: Antrooppinen muoto vaatii antropisen version: 2023-06-01.

SDK:t

Yhteensopiva

Käytä mitä tahansa OpenAI:ta tai Anthropic SDK:ta – muuta vain perus-URL-osoite.

OpenAI-yhteensopivat SDK:t

SDK Python

Virallinen OpenAI Python SDK - toimii Shannonin kanssa

pip install openai

Näytä asiakirjat ->

SDK JavaScript / TypeScript

Virallinen OpenAI Node.js SDK - toimii Shannonin kanssa

npm install openai

Näytä asiakirjat ->

SDK Go

Community Go -asiakasohjelma OpenAI-yhteensopiville sovellusliittymille

go get github.com/sashabaranov/go-openai

Näytä asiakirjat ->

SDK Ruby

Community Ruby -asiakasohjelma OpenAI-yhteensopiville sovellusliittymille

gem install ruby-openai

Näytä asiakirjat ->

SDK PHP

Yhteisön PHP-asiakasohjelma OpenAI-yhteensopiville API:ille

composer require openai-php/client

Näytä asiakirjat ->

SDK Rust

Async Rust -asiakasohjelma OpenAI-yhteensopiville sovellusliittymille

cargo add async-openai

Näytä asiakirjat ->

Ihmisten kanssa yhteensopivat SDK:t

SDK Python (Anthropic)

Virallinen Anthropic Python SDK - toimii Shannonin kanssa

pip install anthropic

Näytä asiakirjat ->

SDK TypeScript (Anthropic)

Virallinen Anthropic TypeScript SDK - toimii Shannonin kanssa

npm install @anthropic-ai/sdk

Näytä asiakirjat ->

Virheiden käsittely

Shannon käyttää tavallisia HTTP-tilakoodeja ja palauttaa yksityiskohtaisia virheilmoituksia.

400 Huono pyyntö Virheellinen pyynnön muoto tai parametrit

401 Luvaton Virheellinen tai puuttuva API-avain

402 Kiintiö ylitetty Tunnus tai hakukiintiö ylitetty

429 Rate Limited Liikaa pyyntöjä, hidasta

500 Palvelinvirhe Sisäinen virhe, yritä myöhemmin uudelleen

Virhevastausmuoto

Virhevastaus

{
  "error": {
    "message": "Invalid API key provided",
    "type": "authentication_error",
    "code": "invalid_api_key"
  }
}

Muutosloki

LOG

Viimeaikaiset päivitykset ja parannukset Shannon-sovellusliittymään.

v2.1.0

2025-01-03

Uusi Lisätty shannon-coder-1 malli Claude Code CLI -integraatioon
Uusi Puhelupohjainen kiintiöjärjestelmä Coder-mallille
Parannettu Parempi toimintokutsujen luotettavuus

v2.0.0

2024-12-15

Uusi Lisätty Anthropic Messages API -yhteensopivuus
Uusi Monikierrostyökalun suoritus (jopa 10 iteraatiota)
Uusi JSON Schema vastausmuodon tuki
Parannettu Parannettu verkkohaku paremmilla viittauksilla

v1.5.0

2024-11-20

Uusi Lisätty shannon-deep-dapo -malli monimutkaista päättelyä varten
Uusi Sisäänrakennettu web_search-toiminto
Parannettu Lyhennetty viive suoratoistovastauksille

v1.0.0

2024-10-01

Uusi Ensimmäinen API-julkaisu
Uusi OpenAI-yhteensopiva chat-päätepiste
Uusi Toimintopuhelutuki
Uusi Suoratoisto palvelimen lähettämien tapahtumien kautta

API-avaimesi

Pääsy

Käytä Bearer-tunnuksia OpenAI-kutsuihin tai X-API-Key + anthropic-versioon.

YOUR_API_KEY

Hanki API-avain

Pidä API-avaimesi salassa. Uudelleen luominen luo uuden avaimen ja mitätöi vanhan.

Sinun käyttösi

Tarkastele tunnuksen ja haun kulutusta tällä sivulla, kun olet kirjautunut tilillesi.

-- API-kutsut

-- Tokeneja käytetty

Shannon API

Yleiskatsaus

Ominaisuudet

Drop-in vaihto

Toiminto kutsu

Sisäänrakennettu verkkohaku

Strukturoidut lähdöt

Monikierrostyökalut

Suoratoisto

Pika-aloitus

Aseta perus-URL-osoite

Lisää API-avain

Lähetä ensimmäinen viestisi

Vastauksen muoto

API Playground

Chat, Responses, Messages

Stream live output

Reuse your key

Todennus

OpenAI-muoto (suositus)

Antrooppinen muoto

Mallit

Toiminto kutsu

Työkalun valintavaihtoehdot

Toiminto Call Response

Strukturoidut lähdöt

Vastausmuotovaihtoehdot

Suoratoisto

Sisäänrakennettu verkkohaku

Antrooppinen muoto

SDK:t

OpenAI-yhteensopivat SDK:t

Ihmisten kanssa yhteensopivat SDK:t

Virheiden käsittely

Virhevastausmuoto

Muutosloki

API-avaimesi

Sinun käyttösi

Shannonin koodaaja (shannon-coder-1)

Valmis rakentamaan?

Shannon AI API Documentation

Yleiskatsaus

Ominaisuudet

Drop-in vaihto

Toiminto kutsu

Sisäänrakennettu verkkohaku

Strukturoidut lähdöt

Monikierrostyökalut

Suoratoisto

Pika-aloitus

Aseta perus-URL-osoite

Lisää API-avain

Lähetä ensimmäinen viestisi

Vastauksen muoto

API Playground

Chat, Responses, Messages

Stream live output

Reuse your key

Todennus

OpenAI-muoto (suositus)

Antrooppinen muoto

Mallit

Toiminto kutsu

Työkalun valintavaihtoehdot

Toiminto Call Response

Strukturoidut lähdöt

Vastausmuotovaihtoehdot

Suoratoisto

Sisäänrakennettu verkkohaku

Antrooppinen muoto

SDK:t

OpenAI-yhteensopivat SDK:t

Ihmisten kanssa yhteensopivat SDK:t

Virheiden käsittely

Virhevastausmuoto

Muutosloki

API-avaimesi

Sinun käyttösi

Shannonin koodaaja (shannon-coder-1)

Valmis rakentamaan?