Logotip de SHANNON A.I.
SHANNONA.I.
XatPreusAPIRecercaEmpresaPentest AIStartup Boost

Carregant la interfície de Shannon...

Comprovant l’estat...
Documentació de l'API

Shannon API

API d'IA compatible amb OpenAI i Anthropic amb crida de funcions, cerca web i sortides estructurades.

Obtén la teva clau APIProva el PlaygroundV2
Documentació
  • Visió general
  • Capacitats
  • Inici ràpid
  • Playground de l’APINou
  • Autenticació
  • Models
  • Crida de funcions
  • Sortides estructurades
  • Streaming
  • Cerca web
  • Anthropic
  • SDKs
  • Gestió d’errors
  • Registre de canvis

Shannon AI API Documentation

Visió general

Documentacio publica

Tot el que necessites per publicar amb l'API compatible d'OpenAI i Anthropic de Shannon.

URL baseCompatible amb OpenAI
https://us-central1-shannonai.cloudfunctions.net/v1/chat/completions

Utilitza l'API de Chat Completions amb crida de funcions i streaming.

URL baseCompatible amb Anthropic
https://us-central1-shannonai.cloudfunctions.net/v1/messages

Format Claude Messages amb eines i capcalera anthropic-version.

CapcaleresAutenticació
Authorization: Bearer <api-key>

O X-API-Key amb anthropic-version per a crides estil Claude.

AccesEstat
Documentacio publica - Cal una clau per fer crides

Streaming, crida de funcions, sortides estructurades, cerca web.

Llista de verificacio de llancament
  • ✓
    Apunta el teu SDK a Shannon
    Estableix baseURL als endpoints OpenAI o Anthropic anteriors.
    Configuracio
  • ✓
    Afegeix la teva clau API
    Utilitza tokens Bearer per a crides OpenAI o X-API-Key + anthropic-version.
    Seguretat
  • ✓
    Activa eines i sortides estructurades
    Admet eines/funcions OpenAI, esquema JSON i web_search integrat.
    Capacitats
  • ✓
    Controla l'us
    Consulta el consum de tokens i cerques en aquesta pagina quan hagis iniciat sessio al teu compte.
    Analitica

Capacitats

OpenAI + Anthropic

Substitut directe d'OpenAI i Anthropic amb suport nadiu per a eines, sortides estructurades i cerca web integrada.

Substitució drop‑in

Compatible

Funciona amb els SDK d’OpenAI i Anthropic. Només canvia l’URL base.

Crida de funcions

Eines

Defineix eines, deixa que Shannon les cridi. Admet modes auto, forced i none.

Cerca web integrada

Cerca

Cerca web en temps real amb citacions de fonts. Disponible automàticament.

Sortides estructurades

JSON

Mode JSON i aplicació d’JSON Schema per a una extracció de dades fiable.

Eines multivolta

Agent

Bucles d’execució automàtica de funcions. Fins a 10 iteracions per sol·licitud.

Streaming

Ràpid

Server‑sent events per al streaming de tokens en temps real.

Inici ràpid

5 minuts

Comença en tres passos. Shannon imita els clients d’OpenAI i Anthropic.

1

Defineix l’URL base

Utilitza l’endpoint compatible amb OpenAI.

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

Afegeix la teva clau API

Utilitza autenticació Bearer a la capçalera Authorization.

3

Envia el teu primer missatge

Tria una llengua i substitueix‑hi la teva clau.

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)

Format de resposta

Resposta d’èxit
{
  "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
  }
}

Playground de l’API

Nou

Prova l’API de Shannon directament al navegador. Crea la sol·licitud, executa‑la i veu la resposta en temps real.

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
}

Autenticació

Totes les sol·licituds API requereixen autenticació amb la teva clau API de Shannon.

Format OpenAI (Recomanat)

HTTP
Authorization: Bearer YOUR_API_KEY

Anthropic

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

Models

Shannon ofereix diversos models optimitzats per a diferents casos d'ús.

shannon-balanced-grpoBalanced

Respostes rapides i eficients per a tasques quotidianes

Context128K
Ideal per aXat, Q&A, generacio de contingut
shannon-deep-dapoDeep

Raonament avancat per a problemes complexos

Context128K
Ideal per aAnalisi, recerca, tasques complexes
shannon-coder-1Coder

Optimitzat per a Claude Code CLI amb quota per crides

Context128K
Ideal per aGeneracio de codi, us d'eines, integracio CLI
Quota per crides

Crida de funcions

Defineix eines que Shannon pot cridar per executar accions o recuperar informació.

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

Opcions de seleccio d'eines

"auto"El model decideix si cridar una funcio (per defecte)
"none"Desactiva la crida de funcions per a aquesta sollicitud
{"type": "function", "function": {"name": "..."}}Forca una crida de funcio especifica

Resposta de crida de funcio

Quan el model crida una funcio
{
  "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"
    }
  ]
}

Sortides estructurades

Força Shannon a respondre amb JSON vàlid que coincideixi amb el teu esquema.

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

Opcions de format de resposta

{"type": "json_object"}Forca una sortida JSON valida (sense esquema especific)
{"type": "json_schema", "json_schema": {...}}Forca una sortida que coincideixi amb el teu esquema exacte

Streaming

Activa l'streaming de tokens en temps real amb Server‑Sent Events per a UI responsives.

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)
Consell: Les respostes en streaming arriben com a Server-Sent Events. Cada fragment conte un delta amb contingut parcial.

Cerca web

Shannon inclou una funció web_search integrada disponible automàticament.

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
Consell pro: Els resultats de cerca web inclouen cites. Shannon citara les fonts automaticament.

Anthropic

Shannon també admet el format Messages API d'Anthropic.

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)
Capcalera obligatoria: El format Anthropic requereix anthropic-version: 2023-06-01.

SDKs

Compatible

Fes servir qualsevol SDK d'OpenAI o Anthropic — només canvia la URL base.

OpenAI-Compatible SDKs

Python

SDK oficial d'OpenAI per a Python - funciona amb Shannon

pip install openai
Veure documentacio
JavaScript / TypeScript

SDK oficial d'OpenAI per a Node.js - funciona amb Shannon

npm install openai
Veure documentacio
Go

Client Go de la comunitat per a APIs compatibles amb OpenAI

go get github.com/sashabaranov/go-openai
Veure documentacio
Ruby

Client Ruby de la comunitat per a APIs compatibles amb OpenAI

gem install ruby-openai
Veure documentacio
PHP

Client PHP de la comunitat per a APIs compatibles amb OpenAI

composer require openai-php/client
Veure documentacio
Rust

Client Rust asincron per a APIs compatibles amb OpenAI

cargo add async-openai
Veure documentacio

Anthropic-Compatible SDKs

Python (Anthropic)

SDK oficial d'Anthropic per a Python - funciona amb Shannon

pip install anthropic
Veure documentacio
TypeScript (Anthropic)

SDK oficial d'Anthropic per a TypeScript - funciona amb Shannon

npm install @anthropic-ai/sdk
Veure documentacio

Gestió d’errors

Shannon utilitza codis d’estat HTTP estàndard i retorna missatges d’error detallats.

400Sol·licitud incorrectaFormat de sol·licitud o paràmetres no vàlids
401No autoritzatClau API no vàlida o absent
402Quota excedidaS’ha excedit la quota de tokens o de cerca
429Limitació de ritmeMassa sol·licituds, redueix la velocitat
500Error del servidorError intern, torna-ho a provar més tard

Format de resposta d’error

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

Registre de canvis

Actualitzacions i millores recents de la Shannon API.

v2.1.0
2025-01-03
  • NouAfegit el model shannon-coder-1 per a la integracio amb Claude Code CLI
  • NouSistema de quota per crides per al model Coder
  • MilloratFiabilitat de crida de funcions millorada
v2.0.0
2024-12-15
  • NouAfegida compatibilitat amb l'API Messages d'Anthropic
  • NouExecucio d'eines en multip torns (fins a 10 iteracions)
  • NouSuport del format de resposta JSON Schema
  • MilloratCerca web millorada amb cites de mes qualitat
v1.5.0
2024-11-20
  • NouAfegit el model shannon-deep-dapo per a raonament complex
  • NouFuncio web_search integrada
  • MilloratLatencia reduida en respostes en streaming
v1.0.0
2024-10-01
  • NouLlançament inicial de l'API
  • NouEndpoint de chat completions compatible amb OpenAI
  • NouSuport de crida de funcions
  • NouStreaming mitjancant Server-Sent Events

Preparat per construir?

Obtén la teva clau API i comença a construir amb Shannon AI avui.

Crea una clau APIVeure docs