SHANNON A.I. Logo
SHANNONA.I.
ChatPräisserAPIFuerschungFirmaPentest AIStartup Boost

Lued Shannon Interface...

Status gëtt gepréift...
API Dokumentatioun

Shannon API

OpenAI- an Anthropic-kompatibel AI-API mat Funktiounsofruff, Websich an strukturéierte Output.

Kritt Ären API-SchlësselPlayground testenV2
Dokumentatioun
  • Iwwersiicht
  • Fäegkeeten
  • Schnellstart
  • API-PlaygroundNei
  • Authentifikatioun
  • Modeller
  • Funktiounsofruff
  • Strukturéiert Output
  • Streaming
  • Integréiert Websich
  • Anthropic-Format
  • SDKen
  • Feelerbehandlung
  • Ännerungslog

Shannon AI API Documentation

Iwwersiicht

Ëffentlech Docs

Alles wat Dir braucht, fir mat Shannon senger OpenAI- an Anthropic-kompatibeler API ze starten.

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

Benotzt d'Chat Completions API mat Funktiounsofruff a Streaming.

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

Claude Messages Format mat Tools an anthropic-version Header.

HTTPAuthentifikatioun
Authorization: Bearer <api-key>

Oder X-API-Key mat anthropic-version fir Claude-ähnlech Uruffen.

ZougangStatut
Ëffentlech Docs - Schlëssel néideg fir Uruff

Streaming, Funktiounsofruff, strukturéierte Output, Websich.

Start-Checklist
  • ✓
    Setzt Ären SDK op Shannon
    Setzt baseURL op déi OpenAI- oder Anthropic-Endpunkten hei uewen.
    Astellung
  • ✓
    API-Schlëssel uginn
    Benotzt Bearer Tokens fir OpenAI-Uruffen oder X-API-Key + anthropic-version.
    Sécherheet
  • ✓
    Tools & strukturéiert Output aktivéieren
    Ënnerstëtzt OpenAI Tools/Funktiounen, JSON Schema an built-in web_search.
    Fäegkeeten
  • ✓
    Nutzung verfollegen
    Gesäit Token- a Sichverbrauch op dëser Säit, wann Dir ageloggt sidd.
    Analytiken

Fäegkeeten

OpenAI + Anthropic

Drop-in Ersatz fir OpenAI- an Anthropic-APIs mat native Support fir Tools, strukturéierte Output an integréiert Websich.

Drop-in Ersatz

Kompatibel

Schafft mat OpenAI- an Anthropic-SDKs. Ännert just d'Base URL.

Funktiounsofruff

Wierkzeugen

Definéiert Tools, loosst Shannon se ruffen. Ënnerstëtzt auto-, forced- an none-Modi.

Integréiert Websich

Sich

Websich an Echtzäit mat Quellennennungen. Automatesch disponibel.

Strukturéiert Output

JSON

JSON-Modus an JSON-Schema-Erzwingung fir zouverlässeg Donnéeausliesen.

Multi-turn Wierkzeugen

Agentësch

Automatesch Funktiouns-Exekutiounsschleifen. Bis zu 10 Iteratiounen pro Ufro.

Streaming

Séier

Server-sent events fir Echtzäit Token-Streaming.

Schnellstart

5 Minutten

Start an dräi Schrëtt. Shannon spigelt OpenAI- an Anthropic-Clients.

1

Base URL setzen

Benotzt den OpenAI-kompatiblen Endpunkt.

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

API-Schlëssel derbäisetzen

Bearer-Auth am Authorization-Header benotzen.

3

Éischt Noriicht schécken

Sprooch auswielen an Äre Schlëssel androen.

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)

Äntwertformat

Succès-Äntwert
{
  "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-Playground

Nei

Test d'Shannon API direkt am Browser. Baut Är Ufro, fuert se aus a kuckt d'Äntwert an Echtzäit.

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
}

Authentifikatioun

All API-Ufroe brauchen Authentifikatioun mat Ärem Shannon API-Schlëssel.

OpenAI Format (Recommandéiert)

HTTP
Authorization: Bearer YOUR_API_KEY

Anthropic-Format

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

Modeller

Shannon bitt verschidde Modeller fir ënnerschiddlech Use-Casen optiméiert.

shannon-balanced-grpoBalanced

Séier, effizient Äntwerten fir Alldagsaufgaben

Kontext128K
Bescht firChat, Q&A, Content Generatioun
shannon-deep-dapoDeep

Fortgeschratt Reasoning fir komplex Problemer

Kontext128K
Bescht firAnalys, Fuerschung, Komplex Aufgaben
shannon-coder-1Coder

Optimiséiert fir Claude Code CLI mat call-baséierter Quota

Kontext128K
Bescht firCode Generatioun, Tool-Notzung, CLI-Integratioun
Call-baséiert Quota

Funktiounsofruff

Definéiert Tools déi Shannon uruffe kann fir Aktiounen auszeféieren oder Informatioun ze kréien.

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}")

Tool-Auswiel Optiounen

"auto"Modell entscheet ob eng Funktioun geruff gëtt (Standard)
"none"Funktiounsofruff fir dës Ufro deaktivéieren
{"type": "function", "function": {"name": "..."}}Eng spezifesch Funktiounsfro erzwingen

Funktiounsofruff-Äntwert

Wann d'Modell eng Funktioun rifft
{
  "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"
    }
  ]
}

Strukturéiert Output

Forcéiert Shannon mat valabelen JSON z'äntweren, dat Är Schema entsprécht.

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"}

Äntwertformat Optiounen

{"type": "json_object"}Valabelen JSON Output forcéieren (kee spezifesche Schema)
{"type": "json_schema", "json_schema": {...}}Output forcéieren deen Ärem exakte Schema entsprécht

Streaming

Echtzäit Token-Streaming mat Server-Sent Events fir reaktiounsfäeg 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)
Tipp: Streaming-Äntwerten kommen als Server-Sent Events. All Chunk enthält en Delta mat deelweisem Inhalt.

Integréiert Websich

Shannon enthält eng built-in web_search Funktioun déi automatesch disponibel ass.

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 Tipp: Websich-Resultater enthalen Zitater. Shannon zitéiert automatesch Quellen.

Anthropic-Format

Shannon ënnerstëtzt och den Anthropic 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)
Noutwennege Header: Anthropic-Format verlaangt anthropic-version: 2023-06-01.

SDKen

Kompatibel

Benotzt all OpenAI oder Anthropic SDK — ännert just d'Base URL.

OpenAI-kompatibel SDKs

Python

Offiziellt OpenAI Python SDK - funktionéiert mat Shannon

pip install openai
Dokumenter kucken
JavaScript / TypeScript

Offiziellt OpenAI Node.js SDK - funktionéiert mat Shannon

npm install openai
Dokumenter kucken
Go

Community Go Client fir OpenAI-kompatibel APIs

go get github.com/sashabaranov/go-openai
Dokumenter kucken
Ruby

Community Ruby Client fir OpenAI-kompatibel APIs

gem install ruby-openai
Dokumenter kucken
PHP

Community PHP Client fir OpenAI-kompatibel APIs

composer require openai-php/client
Dokumenter kucken
Rust

Async Rust Client fir OpenAI-kompatibel APIs

cargo add async-openai
Dokumenter kucken

Anthropic-kompatibel SDKs

Python (Anthropic)

Offiziellt Anthropic Python SDK - funktionéiert mat Shannon

pip install anthropic
Dokumenter kucken
TypeScript (Anthropic)

Offiziellt Anthropic TypeScript SDK - funktionéiert mat Shannon

npm install @anthropic-ai/sdk
Dokumenter kucken

Feelerbehandlung

Shannon benotzt Standard-HTTP-Statuscoden a liwwert detailléiert Feeler-Noriichten.

400Feelerhaft UfroOngëltege Request-Format oder Parameter
401Net autoriséiertOngëltegen oder feelenden API-Schlëssel
402Quota iwwerschrattToken- oder Sichquota iwwerschratt
429Rate limitéiertZe vill Ufroen, lues maachen
500ServerfeelerIntern Feeler, spéider nach eng Kéier probéieren

Feeler-Äntwertformat

Feeler-Äntwert
{
  "error": {
    "message": "Invalid API key provided",
    "type": "authentication_error",
    "code": "invalid_api_key"
  }
}

Ännerungslog

Rezent Aktualiséierungen an Verbesserungen un der Shannon API.

v2.1.0
2025-01-03
  • Neishannon-coder-1 Modell fir Claude Code CLI Integratioun derbäi
  • NeiCall-baséiert Quota System fir Coder Modell
  • VerbessertFunktiounsofruff Zouverlässegkeet verbessert
v2.0.0
2024-12-15
  • NeiAnthropic Messages API Kompatibilitéit derbäi
  • NeiMulti-turn Tool-Exekutioun (bis zu 10 Iteratiounen)
  • NeiJSON Schema Äntwertformat Support
  • VerbessertVerbessert Websich mat bessere Zitater
v1.5.0
2024-11-20
  • Neishannon-deep-dapo Modell fir komplex Reasoning derbäi
  • NeiBuilt-in web_search Funktioun
  • VerbessertLatenz fir Streaming-Äntwerten reduzéiert
v1.0.0
2024-10-01
  • NeiÉischt API-Release
  • NeiOpenAI-kompatiblen Chat-Completions Endpunkt
  • NeiFunktiounsofruff Support
  • NeiStreaming iwwer Server-Sent Events

Bereet fir ze bauen?

Kritt Ären API-Schlëssel a start haut mam Shannon AI ze bauen.

Kritt Ären API-SchlësselPräisser kucken