SHANNON A.I. Logo
SHANNONA.I.
ChatHinnoitteluAPITutkimusYritysPentest AIStartup Boost

Ladataan Shannon-käyttöliittymää...

Tarkistetaan tilaa...
API-dokumentaatio

Shannon API

OpenAI- ja Anthropic‑yhteensopiva AI‑API, jossa on funktionkutsut, web‑haku ja rakenteiset tulosteet.

Hanki API‑avainKokeile PlaygroundiaV2
Dokumentaatio
  • Yleiskatsaus
  • Ominaisuudet
  • Pika‑aloitus
  • API‑leikkikenttäUusi
  • Todennus
  • Mallit
  • Funktiokutsut
  • Rakenteiset tulosteet
  • Suoratoisto
  • Sisäänrakennettu web‑haku
  • Anthropic‑muoto
  • SDK:t
  • Virheiden käsittely
  • Muutosloki

Shannon AI API Documentation

Yleiskatsaus

Julkiset dokumentit

Kaikki mitä tarvitset julkaisuun Shannonin OpenAI‑ ja Anthropic‑yhteensopivalla API:lla.

Perus-URLOpenAI-Compatible
https://us-central1-shannonai.cloudfunctions.net/v1/chat/completions

Use the Chat Completions API with function calling and streaming.

Perus-URLAnthropic-Compatible
https://us-central1-shannonai.cloudfunctions.net/v1/messages

Claude Messages format with tools and anthropic-version header.

OtsakkeetTodennus
Valtuutus: Bearer <avaimesi>

Or X-API-Key with anthropic-version for Claude-style calls.

AccessStatus
Public docs - Key required to call

Streaming, function calling, structured outputs, web search.

Launch checklist
  • ✓
    Point your SDK at Shannon
    Set baseURL to the OpenAI or Anthropic endpoints above.
    Setup
  • ✓
    Attach your API key
    Use Bearer tokens for OpenAI calls or X-API-Key + anthropic-version.
    Security
  • ✓
    Enable tools & structured outputs
    Supports OpenAI tools/functions, JSON schema, and built-in web_search.
    Ominaisuudet
  • ✓
    Track usage
    View token and search consumption on this page when signed in to your account.
    Analytics

Ominaisuudet

OpenAI + Anthropic

Drop-in replacement for OpenAI and Anthropic APIs with native support for tools, structured outputs, and built-in web search.

Drop‑in‑korvaus

Yhteensopiva

Toimii OpenAI‑ ja Anthropic‑SDK:iden kanssa. Vaihda vain perus‑URL.

Funktiokutsut

Työkalut

Määritä työkalut, Shannon kutsuu niitä. Tukee auto-, forced- ja none‑tiloja.

Sisäänrakennettu verkkohaku

Haku

Reaaliaikainen verkkohaku lähdeviittein. Saatavilla automaattisesti.

Rakenteiset tulosteet

JSON

JSON‑tila ja JSON‑skeneman pakotus luotettavaan datan poimintaan.

Monikierroksiset työkalut

Agenttinen

Automaattiset funktioiden suoritus­silmukat. Enintään 10 iteraatiota per pyyntö.

Suoratoisto

Nopea

Server‑sent events reaaliaikaiseen token‑streamaukseen.

Pika‑aloitus

5 minuuttia

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

1

Aseta perus‑URL

Käytä OpenAI‑yhteensopivaa endpointia.

https://us-central1-shannonai.cloudfunctions.net/v1/chat/completions
2

Lisää API‑avain

Käytä Bearer‑autentikointia Authorization‑otsikossa.

3

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://us-central1-shannonai.cloudfunctions.net/v1"
)
response = client.chat.completions.create(
model="shannon-balanced-grpo",
messages=[
{"role": "system", "content": "You are a helpful assistant."},
{"role": "user", "content": "Hello, Shannon!"}
],
max_tokens=1024
)
print(response.choices[0].message.content)

Vastausmuoto

Onnistunut vastaus
{
  "id": "chatcmpl-abc123",
  "object": "chat.completion",
  "created": 1234567890,
  "model": "shannon-balanced-grpo",
  "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‑leikkikenttä

Uusi

Testaa Shannon API:tä suoraan selaimessa. Rakenna pyyntö, suorita se ja näe vastaus reaaliajassa.

Claude-style API studio

One polished workbench for every public endpoint.

Switch between Chat Completions, Responses, and Messages without changing pages. The request body, auth header, stream parser, and SDK snippets all follow the selected protocol.

Endpoints3
ThemeCrail / Pampas
Latest response IDNot captured yet
Composer

Chat Completions

Live response

/v1/chat/completions

Chat Completions Idle 0 SSE events No reasoning block
response_idWaiting for a response...
Ready to test.

Pick an endpoint, shape the payload, and run the request to inspect the live output.

0
SDK snippets

Keep the request, headers, and client syntax aligned with the selected endpoint.

JSON
{
"model": "shannon-balanced-grpo",
"messages": [
{
"role": "system",
"content": "You are Shannon. Answer crisply, commercially, and with strong structure."
},
{
"role": "user",
"content": "Outline a clean launch plan for a new AI API aimed at startup founders."
}
],
"max_tokens": 1024,
"temperature": 0.7,
"stream": true
}

Todennus

All API requests require authentication using your Shannon API key.

OpenAI Format (Recommended)

HTTP
Authorization: Bearer YOUR_API_KEY

Anthropic‑muoto

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

Mallit

Shannon offers multiple models optimized for different use cases.

shannon-balanced-grpoBalanced

Fast, efficient responses for everyday tasks

Konteksti128K
Paras käyttöönChat, Q&A, Content Generation
shannon-deep-dapoDeep

Advanced reasoning for complex problems

Konteksti128K
Paras käyttöönAnalysis, Research, Complex Tasks
shannon-coder-1Coder

Optimized for Claude Code CLI with call-based quota

Konteksti128K
Paras käyttöönCode Generation, Tool Use, CLI Integration
Call-based quota

Funktiokutsut

Define tools that Shannon can call to perform actions or retrieve information.

Python
from openai import OpenAI
import json
client = OpenAI(
api_key="YOUR_API_KEY",
base_url="https://us-central1-shannonai.cloudfunctions.net/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-balanced-grpo",
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}")

Työkalun valinta-asetukset

"auto"Model decides whether to call a function (default)
"none"Disable function calling for this request
{"type": "function", "function": {"name": "..."}}Force a specific function call

Funktiokutsun vastaus

When model calls a function
{
  "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"
    }
  ]
}

Rakenteiset tulosteet

Force Shannon to respond with valid JSON that matches your schema.

Python
from openai import OpenAI
client = OpenAI(
api_key="YOUR_API_KEY",
base_url="https://us-central1-shannonai.cloudfunctions.net/v1"
)
# Force JSON output with schema
response = client.chat.completions.create(
model="shannon-balanced-grpo",
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"}

Vastausmuodon asetukset

{"type": "json_object"}Force valid JSON output (no specific schema)
{"type": "json_schema", "json_schema": {...}}Force output matching your exact schema

Suoratoisto

Enable real-time token streaming with Server-Sent Events for responsive UIs.

Python
from openai import OpenAI
client = OpenAI(
api_key="YOUR_API_KEY",
base_url="https://us-central1-shannonai.cloudfunctions.net/v1"
)
# Enable streaming for real-time responses
stream = client.chat.completions.create(
model="shannon-balanced-grpo",
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)
Vinkki: Streaming responses arrive as Server-Sent Events. Each chunk contains a delta with partial content.

Sisäänrakennettu web‑haku

Shannon includes a built-in web_search function that's automatically available.

Python
from openai import OpenAI
client = OpenAI(
api_key="YOUR_API_KEY",
base_url="https://us-central1-shannonai.cloudfunctions.net/v1"
)
# Web search is automatically available!
# Shannon will use it when needed for current information
response = client.chat.completions.create(
model="shannon-balanced-grpo",
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
Pro-vinkki: Web search results include citations. Shannon will automatically cite sources.

Anthropic‑muoto

Shannon also supports Anthropic's Messages API format.

https://us-central1-shannonai.cloudfunctions.net/v1/messages
Python
import anthropic
client = anthropic.Anthropic(
api_key="YOUR_API_KEY",
base_url="https://us-central1-shannonai.cloudfunctions.net/messages"
)
response = client.messages.create(
model="shannon-balanced-grpo",
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)
Pakollinen otsake: Anthropic format requires anthropic-version: 2023-06-01.

SDK:t

Yhteensopiva

Use any OpenAI or Anthropic SDK - just change the base URL.

OpenAI-Compatible SDKs

Python

Official OpenAI Python SDK - works with Shannon

pip install openai
View Docs
JavaScript / TypeScript

Official OpenAI Node.js SDK - works with Shannon

npm install openai
View Docs
Go

Community Go client for OpenAI-compatible APIs

go get github.com/sashabaranov/go-openai
View Docs
Ruby

Community Ruby client for OpenAI-compatible APIs

gem install ruby-openai
View Docs
PHP

Community PHP client for OpenAI-compatible APIs

composer require openai-php/client
View Docs
Rust

Async Rust client for OpenAI-compatible APIs

cargo add async-openai
View Docs

Anthropic-Compatible SDKs

Python (Anthropic)

Official Anthropic Python SDK - works with Shannon

pip install anthropic
View Docs
TypeScript (Anthropic)

Official Anthropic TypeScript SDK - works with Shannon

npm install @anthropic-ai/sdk
View Docs

Virheiden käsittely

Shannon käyttää standardeja HTTP‑tilakoodeja ja palauttaa yksityiskohtaiset virheet.

400Virheellinen pyyntöVirheellinen pyyntömuoto tai parametrit
401Ei valtuutettuVirheellinen tai puuttuva API‑avain
402Kiintiö ylitettyToken‑ tai haku‑kiintiö ylitetty
429RajoitettuLiikaa pyyntöjä, hidasta
500PalvelinvirheSisäinen virhe, yritä myöhemmin

Virhevastausmuoto

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

Muutosloki

Recent updates and improvements to the Shannon API.

v2.1.0
2025-01-03
  • UusiAdded shannon-coder-1 model for Claude Code CLI integration
  • UusiCall-based quota system for Coder model
  • ImprovedImproved function calling reliability
v2.0.0
2024-12-15
  • UusiAdded Anthropic Messages API compatibility
  • UusiMulti-turn tool execution (up to 10 iterations)
  • UusiJSON Schema response format support
  • ImprovedEnhanced web search with better citations
v1.5.0
2024-11-20
  • UusiAdded shannon-deep-dapo model for complex reasoning
  • UusiBuilt-in web_search function
  • ImprovedReduced latency for streaming responses
v1.0.0
2024-10-01
  • UusiInitial API release
  • UusiOpenAI-compatible chat completions endpoint
  • UusiFunction calling support
  • UusiStreaming via Server-Sent Events

Valmis rakentamaan?

Get your API key and start building with Shannon AI today.

Hanki API‑avainNäytä hinnat