API-Dokumentation

Downloads für Python 0.3.7 und Node 0.3.7

Die versionsgebundenen Downloads dieser Seite verwenden Python 0.3.7 und Node 0.3.7 und enthalten die detaillierte Modellerkennung. Erforderlich sind Python ab 3.9 sowie Node ab 20 für Node.js und lokales MCP. Diese Archive bedeuten keine Veröffentlichung auf npm oder PyPI. Das normale Node-SDK benötigt keine optionalen MCP-Abhängigkeiten.

Kundenquellcode und Anbieterzugangsdaten sind nicht erforderlich. Geben Sie Sprache/Laufzeit und SDK-Version, model_code + operation + mode, bereinigte Parameter, Mediengrenzen und URL-Gültigkeit, Wiederaufnahme, Währungsbudget und Parallelitätsziel an. REST ist der Ausführungsvertrag; SDKs sind optionale schlanke Clients, lokales MCP ein stdio-Zugang für Agenten. Das eigene SDK verwendet einen Ursprung ohne /v1. Ein Anbieter-SDK kann Feldzuordnung und Wiederholungen anpassen müssen; nur Schlüssel oder Basis-URL zu ersetzen garantiert keine multimodale Kompatibilität. Bereinigte Anfrage-/Antwortbeispiele und erwartete Ergebnisse abstimmen. Zuerst synthetische Antworten für 200/202, ausstehendes GET, unvollständiges SSE, unbekannte Übermittlung und doppelte Lieferung prüfen; kostenpflichtige Abnahme braucht gesonderte Freigabe und klares Budget.

python -m pip install "https://routershift.com/downloads/sdk/routershift-0.3.7-py3-none-any.whl"

Für Ihren API-Schlüssel sichtbare Modelle auflisten

Führen Sie zuerst diese schreibgeschützte Anfrage aus und übernehmen Sie einen exakten Modellcode in die folgenden Beispiele. Die Liste zeigt nur, was der Schlüssel sehen kann; sie bestätigt nicht, dass jede Operation oder jeder Modus für das Modell aktiviert ist.

Verwenden Sie denselben Ausführungsschlüssel für GET /v1/models?details=1: keine Aufgabe, Geldreservierung oder Anbieteraufrufe; Authentifizierung, Protokolle und Ratenlimits gelten weiter. Prüfen Sie Endpunkte/Modi in details.operations, constraints.status und import_contract.status/reason. Bewahren Sie Dimensionen, Bedingungen, Währung, Genauigkeit, Selektoren, Beobachtungszeit und semantic_sha256. Referenzpreise sind kein ausführbarer Vertrag. Fehlende/unbekannte Grenzen erlauben keine unbegrenzten Eingaben; available garantiert kein Guthaben. Dies ist weder ein vollständiges Eingabe-Schema noch eine universelle Nicht-Token-Vertragsprojektion. models.list() bleibt standardmäßig die normale Liste; Details ausdrücklich über die enthaltenen SDK-Methoden oder REST anfordern. Bei constraints beschreibt available die geprüfte Operationsteilmenge; unsupported erfordert operationsspezifische Hinweise.

details.constraints.operations[].scope unterscheiden: reviewed_subset bezeichnet die geprüfte Operationsteilmenge; finite_admission_opt_in gilt nur für ausdrücklich begrenzte Anfragen, nicht für normalen Chat allgemein. parameters ist kein vollständiges Eingabe-Schema. Falls details.admission vorhanden ist, status, profile, /details/admission/required_headers und erklärte Eingabe-/Ausgabegrenzen prüfen; unbekannte Modelle bleiben unavailable. Erkennung gewährt weder Guthaben noch eine universelle Preisobergrenze.

Node 0.3.7 enthält listDetails() und die Option details=true für models.list; Python 0.3.7 enthält models.list(details=True) und list_details(). Diese detaillierten Erkennungsmethoden sind in den Paketen dieser Version enthalten. models.list() liefert standardmäßig weiterhin die normale Liste; ältere Installationen erhalten neue Methoden nicht automatisch.

curl --fail-with-body --connect-timeout 10 --max-time 30 "https://api.routershift.com/v1/models?details=1" \
  -H "Authorization: Bearer $ROUTERSHIFT_API_KEY"

Textgespräche

Python, Node und MCP können Textmodelle aufrufen. Agenten können ihr Hauptmodell behalten und RouterShift bei Bedarf nutzen. Modellberechtigungen und Kosten bleiben in derselben API.

import os
from routershift import RequestOptions, RouterShift

client = RouterShift(api_key=os.environ["ROUTERSHIFT_API_KEY"])
response = client.chat.completions.create(
    model="YOUR_TEXT_MODEL_CODE",
    messages=[{"role": "user", "content": "Summarize this project in one sentence."}],
    request_options=RequestOptions(max_retries=0),
)
print(response.choices[0].message.content)

Omni-Anfragen über HTTP

Dieses Beispiel sendet WAV-Audio und fordert Text und Audio über einen HTTP-Stream an. Wählen Sie eine abgenommene OpenAI-kompatible Route sowie einen vom Modell unterstützten stream-Modus und eine Stimme. Reine SSE-Modelle benötigen stream:true; auch routershift_chat akzeptiert diese Option. Das SDK bewahrt Inhaltsblöcke, Audio, Modalitäten, Werkzeugaufrufe und Audioantworten. HTTP Omni bietet weder Realtime-WebSockets noch beliebige Protokollkonvertierung zwischen Anbietern.

import base64
import os
from pathlib import Path
from routershift import RequestOptions, RouterShift

client = RouterShift(api_key=os.environ["ROUTERSHIFT_API_KEY"])
audio_data = base64.b64encode(Path("/absolute/path/to/sample.wav").read_bytes()).decode()
response = client.chat.completions.create(
    model="YOUR_OMNI_MODEL_CODE",
    messages=[{"role": "user", "content": [
        {"type": "text", "text": "Describe the sound."},
        {"type": "input_audio", "input_audio": {"data": audio_data, "format": "wav"}},
    ]}],
    stream=True,
    modalities=["text", "audio"],
    audio={"voice": "YOUR_MODEL_VOICE", "format": "wav"},
    request_options=RequestOptions(max_retries=0),
)
for chunk in response:
    if chunk.choices:
        delta = chunk.choices[0].delta or {}
        print(delta.get("content", ""), end="")
        if delta.get("audio"):
            print(delta["audio"].get("transcript", ""), end="")

Sprachausgabe

audio.speech ruft /v1/audio/speech auf. Python gibt Audiobytes zurück; Node liefert data-Bytes und den tatsächlichen contentType. Wählen Sie eine unterstützte Stimme und ein unterstütztes Format. Die Audiodaten werden nicht automatisch lokal gespeichert.

import os
from routershift import RouterShift

client = RouterShift(api_key=os.environ["ROUTERSHIFT_API_KEY"])
speech = client.audio.speech(
    model="YOUR_SPEECH_MODEL_CODE",
    input="Welcome to RouterShift.",
    voice="YOUR_MODEL_VOICE",
    response_format="wav",
)
print(len(speech))

Audiotranskription

audio.transcribe sendet die ausdrücklich ausgewählte Audiodatei per multipart an /v1/audio/transcriptions. Behalten Sie die tatsächliche Dateiendung bei. Das Beispiel fordert JSON an und liest text; Sprachen und Formate hängen von der Route ab.

import os
from pathlib import Path
from routershift import RouterShift

client = RouterShift(api_key=os.environ["ROUTERSHIFT_API_KEY"])
transcript = client.audio.transcribe(
    model="YOUR_TRANSCRIPTION_MODEL_CODE",
    file=Path("/absolute/path/to/sample.wav").read_bytes(),
    filename="sample.wav",
    response_format="json",
)
print(transcript.text)

Eine HTTPS-Audio-URL transkribieren

Verwenden Sie audio.transcribe_url in Python, audio.transcribeURL in Node.js oder senden Sie JSON mit file_url an /v1/transcriptions. Das SDK prüft die HTTPS-URL und lädt die Aufnahme nicht lokal herunter. Die Go- und Java-Reiter verwenden die jeweiligen Standard-HTTP-Clients; RouterShift beansprucht keine eigenen Go- oder Java-SDKs.

import os
from routershift import RouterShift

client = RouterShift(api_key=os.environ["ROUTERSHIFT_API_KEY"])
transcript = client.audio.transcribe_url(
    "YOUR_TRANSCRIPTION_MODEL_CODE",
    "https://media.example/recording.wav",
    language="en",
    audio_format="wav",
    response_format="json",
)
print(transcript.text)

Bilder erzeugen und Bildaufgaben abfragen

Verwenden Sie images.generate mit einem für Bilderzeugung freigeschalteten Modell. Bei Modellen mit asynchronen Bildern ergänzen Sie async_=True in Python oder async: true in Node.js und fragen die zurückgegebene id mit images.retrieve ab. Fertige Antworten enthalten data mit Bild-URLs; ausstehende Antworten enthalten id und status.

import os
from routershift import ImageTaskResponse, RouterShift

client = RouterShift(api_key=os.environ["ROUTERSHIFT_API_KEY"])
image = client.images.generate(
    model="YOUR_IMAGE_MODEL_CODE",
    prompt="A quiet garden in watercolor",
)
print(image)
if isinstance(image, ImageTaskResponse):
    print(client.images.retrieve(image.id))

Ein Video beauftragen und den Status abfragen

videos.create übermittelt eine Videoaufgabe und liefert task_id. Speichern Sie diese vor dem Aufruf von videos.retrieve; bei ausstehenden Aufgaben kann video_url noch fehlen. Beide SDKs bieten videos.poll für zeitlich begrenztes Warten. Der API-Pfad lautet /v1/video/generations, mit video im Singular.

Verifizierte native Seedance- und Wan-3.0-Routen unterstützen generate_audio: Weglassen bewahrt den Anbieterstandard, false fordert keine Tonspur an, true eine Tonspur. Wan bildet dies auf parameters.audio ab und aktiviert Ton derzeit standardmäßig. Mit und ohne Ton gilt derselbe Wan-Videotarif ohne zusätzliche Audiogebühr. Andere Routen unterstützen das Feld möglicherweise nicht; explizite Werte werden nicht stillschweigend entfernt.

import os
from routershift import RouterShift

client = RouterShift(api_key=os.environ["ROUTERSHIFT_API_KEY"])
task = client.videos.create(
    model="YOUR_VIDEO_MODEL_CODE",
    prompt="A slow camera movement through a garden",
)
print(task.task_id)
result = client.videos.retrieve(task.task_id)
print(result.status, result.video_url)

Modellwerkzeuge zu einem Agenten hinzufügen

Ergänzen Sie einen Agenten über MCP um Werkzeuge oder verwenden Sie das Python/Node-SDK im Anwendungscode: Beide Zugänge stehen parallel zur Verfügung. Folgen Sie diesen vier lokalen stdio-Schritten und speichern Sie keine Zugangsdaten in geteilter Konfiguration oder Versionsverwaltung.

1. 1. Ein eigenes Verzeichnis anlegen und MCP installieren

   Verwenden Sie Node 20 oder neuer. Diese reine MCP-Installation ergänzt die beiden Peer-Abhängigkeiten des Protokolls; eine normale Node-SDK-Installation benötigt sie nicht.

   shell

   Kopieren

   mkdir routershift-mcp
   cd routershift-mcp
   npm init -y
   npm install "https://routershift.com/downloads/sdk/routershift-sdk-0.3.7.tgz" @modelcontextprotocol/server@2.0.0 zod@4.6.4

2. 2. Absoluten Server-Einstieg ermitteln

   Führen Sie den Befehl im neuen Verzeichnis aus. Er gibt einen JSON-escaped absoluten Pfad aus, den Sie in das args-Array der Konfiguration einfügen können.

   Node.js

   Kopieren

   node -p "JSON.stringify(require('node:path').resolve('node_modules/@routershift/sdk/dist/mcp/cli.js'))"

3. 3. Lokalen stdio-Client konfigurieren

   Ersetzen Sie den Beispielpfad, setzen Sie den API-Schlüssel nur in Ihrer lokalen Umgebung und verwenden Sie den vertrauenswürdigen API-Origin ohne /v1, Zugangsdaten, Query oder Fragment. Der Codex-Tab nutzt die dokumentierte stdio- und env_vars-Syntax.

   mcpServers JSONCodex TOML

   Kopieren

   {
     "mcpServers": {
       "routershift": {
         "command": "node",
         "args": [
           "/absolute/path/to/your/project/node_modules/@routershift/sdk/dist/mcp/cli.js"
         ],
         "env": {
           "ROUTERSHIFT_API_KEY": "sk-REPLACE_LOCALLY",
           "ROUTERSHIFT_BASE_URL": "https://api.routershift.com"
         }
       }
     }
   }

4. 4. Connector neu starten und zehn Werkzeuge prüfen

   Starten oder laden Sie den MCP-Client neu, bestätigen Sie alle zehn Werkzeuge und rufen Sie zuerst das schreibgeschützte routershift_list_models auf. Verwenden Sie ein kostenpflichtiges Modellwerkzeug nur, wenn Sie den Vorgang absichtlich absenden möchten.

Zehn Werkzeuge stehen bereit: routershift_list_models, routershift_estimate_chat, routershift_chat, routershift_generate_image, routershift_create_video, routershift_get_task, routershift_get_request, routershift_speech, routershift_transcribe, routershift_transcribe_url. Wählen Sie zuerst ein Modell für die gewünschte Operation. Bild- und Videoaufgaben fragen Sie mit routershift_get_task sowie kind (image oder video) und task_id ab. Fragen Sie einen Anfragebeleg mit dem schreibgeschützten routershift_get_request und request_id ab; dabei wird kein kostenpflichtiger Vorgang übermittelt oder aktiviert. In 0.3.7 liest details:true detaillierte Modelle und Verträge. routershift_estimate_chat liest nur eine endliche Zulassungsobergrenze: kein Anbieteraufruf, keine Reservierung und keine automatische Ausführung; funds_verified=false. Ein Angebot ist weder Endabrechnung noch Aufrufgenehmigung.

routershift_chat akzeptiert HTTPS-Verweise auf Bilder und Videos; audio_file liest einen ausdrücklich gewählten absoluten WAV/MP3-Pfad mit höchstens 16 MiB. routershift_transcribe liest eine ausgewählte lokale Audiodatei über file_path; routershift_transcribe_url übergibt eine HTTPS-file_url, ohne sie herunterzuladen. Sprach- und Omni-Audio wird eingebettet zurückgegeben. routershift_generate_image akzeptiert response_format url oder b64_json; für begrenzte, gültige PNG-, JPEG-, WebP- oder GIF-b64_json-Ausgaben liefert es nativen MCP-image-Inhalt, ohne eine Datei zu schreiben, herunterzuladen oder neu zu hosten und ohne Base64 in Text-JSON zu kopieren. Zu große Bilddaten oder unbekannte Formate werden ausdrücklich ausgelassen; senden Sie keine kostenpflichtige Anfrage erneut, um ausgelassene Ausgaben abzurufen. Der Adapter durchsucht keine Verzeichnisse und speichert Ergebnisse nicht automatisch.

Der JSON-Tab zeigt die übliche mcpServers-Struktur; der TOML-Tab zeigt die dokumentierte Codex-Syntax. Konfigurationsorte und Unterprozessrechte unterscheiden sich je nach Client. Reine Remote-MCP-Clients benötigen einen separat unterstützten Transport; diese Beispiele behaupten keine Tests in jeder Agentenoberfläche.

Der lokale MCP-Adapter ermöglicht Aufrufe der RouterShift-APIs für Text, Multimodalität, Audio und Aufgaben. Das bestehende /v1/mcp-Gateway stellt konfigurierte externe Werkzeuge bereit. Seine HTTP/SSE-Konfiguration ersetzt nicht die hier gezeigte lokale Konfiguration der Modellwerkzeuge.