ShareAI Platform Docs
WISSENSDATENBANK

API-Referenz

Anwendungen authentifizieren, Text und Bilder generieren, Embeddings erstellen und Anbieter-, Geräte- und Creator-Workflows automatisieren.

Als Markdown anzeigen

Erstellen Sie Ihre erste API-Anfrage

Erstellen Sie einen ShareAI-API-Schlüssel, wählen Sie ein verfügbares Modell aus und senden Sie eine Chat-Anfrage von Ihrem Server mit Bearer-Authentifizierung.

Wählen Sie die richtige API und Anmeldedaten

Finden Sie ShareAI API-Endpunkte für Anwendungs-Auth, Chat, Antworten, Einbettungen, Bilder, Provider, Geräte und Creator mit der richtigen URL und den entsprechenden Zugangsdaten.

Registrieren Sie Ihre Anwendung

Erstellen Sie eine Anwendung, wählen Sie ihr Bereitstellungsmodell und aktivieren Sie nur die ShareAI-Funktionen, die sie benötigt.

Autorisieren Sie ein Konto mit PKCE

Verwenden Sie den Autorisierungscode zusammen mit S256 PKCE für vertrauliche und öffentliche Anwendungen.

Wählen Sie Login-, Zahlungs- und KI-Berechtigungen

Anmeldung, Produktzahlungen und Inferenzzuschläge erfordern separate Funktionen und die Autorisierung des Kunden.

Aktualisieren Sie ein Zugriffstoken

Drehen Sie Refresh-Tokens, ohne die autorisierten Bereiche des Kunden zu erweitern.

Lesen Sie Identität und entdecken Sie Auth-Endpunkte

Verwenden Sie ShareAI Auth Discovery, JWKS und UserInfo, um die Anmeldung der Anwendung zu validieren und die Identität zu lesen, die durch ein OAuth-Zugriffstoken erlaubt ist.

Widerrufen Sie Tokens und prüfen Sie serverseitige Autorisierungen

Widerrufen Sie ungenutzte Zugriffs- und Refresh-Tokens. Vertrauliche Integrationen können auch den Token-Status überprüfen.

Verstehen Sie akzeptierte Abrechnungsvereinbarungen

Halten Sie den Abonnementpreis, das Intervall und den KI-Zuschlag an die Bedingungen gebunden, die jeder Kunde akzeptiert hat.

Erstellen Sie einen Chat-Abschluss

Senden Sie eine ShareAI-Chat-Abschlussanfrage mit einem Bearer-API-Schlüssel und verstehen Sie das unterstützte Modell, die Nachrichten und Stream-Felder.

Senden Sie Chat-Anfragen mit OAuth

Verwenden Sie ein genehmigtes ShareAI-OAuth-Zugriffstoken für kundenfinanzierte Chat-Abschlüsse und verwalten Sie Token-Ablauf, Zustimmung und Kontogrenzen.

Streamen Sie eine Chat-Antwort

Lesen Sie ShareAI-Chat-Vervollständigungs-Server-Sent-Events, fügen Sie Inhaltsdeltas einmal hinzu und behandeln Sie Vervollständigungen, Fehler und unterbrochene Streams.

Überprüfen Sie Schlüsselzugriff und Kontoidentität

Lesen Sie die Informationen zum ShareAI-API-Schlüssel, um Modell- und Anbieterbeschränkungen sowie die mit einer Inferenzberechtigung verknüpfte Kontenidentität zu überprüfen.

Eine Textantwort erstellen

Verwenden Sie die ShareAI-Responses-API für zustandslose Textgenerierung, explizite Gesprächsverläufe und Responses-Streaming-Ereignisse.

Texteinbettungen erstellen

Generieren Sie Texteinbettungen mit ShareAI für semantische Suche, Abruf und Ähnlichkeit mit unterstützten Eingabeformaten und Modellanforderungen.

Ein Bild generieren

Erstellen Sie Bilder mit der ShareAI Images API unter Verwendung eines unterstützten Modells, einer Texteingabe und validierter Bildgenerierungsoptionen.

Authentifizieren Sie die Provider-API

Aktivieren Sie Remotezugriff für Anbieter und verwenden Sie eine Anbieter-UUID sowie ein Zugriffstoken mit festgelegtem Umfang für Katalog- und Preisabfragen.

Listen Sie Provider- und Netzwerkmodelle auf

Lesen Sie den ShareAI Provider API-Netzwerkkatalog, Ihren Provider-Katalog und die genauen Modelldetails mit provider_models:read.

Aktualisieren Sie die Preisgestaltung des Provider-Modells

Legen Sie Eingabe-, Ausgabe- und Cache-Preisstufen für ShareAI-Anbieter-Modelle mit einem begrenzten Anbieter-API-Token und einem genauen Modell-Identifier fest.

Authentifizieren Sie die Geräte-API

Erstellen Sie ein gerätespezifisches Fernsteuerungs-Token und verstehen Sie die Anbieter-, Geräte- und Aktivierungsstatusprüfungen für ShareAI-Geräte-API-Anfragen.

Lesen Sie Gerätesitzungen und Aufgabenverlauf

Listen Sie ShareAI-Gerätesitzungen auf und prüfen Sie den Aufgabenverlauf einer Sitzung mit einem gerätespezifischen Remote-Control-Token.

Starten und stoppen Sie die Gerätefreigabe

Senden Sie ShareAI-Gerätefreigabebefehle, unterscheiden Sie akzeptierte Befehle vom beobachteten Zustand und überprüfen Sie das Ergebnis in der Konsole.

Authentifizieren Sie die Creator-API

Verwenden Sie creator-spezifische Remote Access-Anmeldedaten und verstehen Sie die verfügbaren Bereiche für Sammlung, Modell und Einstellungen in der ShareAI Creator API.

Lesen und verwalten Sie Modellkollektionen

Listen, erstellen und aktualisieren Sie ShareAI Creator-Modellsammlungen mit den erforderlichen Bereichen sowie klaren Eigentums- und Überprüfungsgrenzen.

Erstellen Sie ein Modellpaket

Erstelle ShareAI Creator-Modell-Metadaten, eine Sammlung und Modell-Tags zusammen, mit expliziter Zugriffsrichtlinie und begrenzten API-Zugangsdaten.

Verwalten Sie Modelle innerhalb einer Kollektion

Listen, lesen, erstellen und aktualisieren Sie ShareAI Creator-Modell-Tags, während Sie deren Sammlungszugehörigkeit und effektive Bereitstellungsrichtlinie beibehalten.

Behandeln Sie API-Fehler und Wiederholungen

Diagnostizieren Sie ShareAI-Authentifizierungs-, Umfangs-, Modellzugriffs- und Verfügbarkeitsfehler ohne doppelte Schreibvorgänge oder unsichere Aktualisierungsversuche.

Verstehen Sie Modell-Ersteller, Bezeichner und Tags

Wählen Sie eine genaue, auf dem Creator basierende ShareAI-Modellkennung, erkunden Sie deren Familie und vergleichen Sie die Anbieter, die sie ausführen können.

Wählen Sie Ausführungsanbieter für eine API-Anfrage

Verwenden Sie das ShareAI-Anbieterobjekt, um Ausführungsanbieter unabhängig vom Ersteller eines Modells über alle vier Inferenz-Endpunkte hinweg auszuwählen.

Anbieter-Richtlinienreferenz

Referenzieren Sie die ShareAI-Provider-Felder, Standardwerte, Limits und Fehler, um Ausführungsanbieter in Inferenzanfragen auszuwählen.

Anbieter sortieren und Fallback steuern

Verstehen Sie die Preis-, Latenz- und Durchsatz-Rankings von ShareAI, geordnete Anbieter, nicht verfügbare Messungen und sichere Fallback-Grenzen.

Verstehen Sie Kundenidentitäten

Jeder OAuth-Client erhält eine andere Kennung für denselben ShareAI-Kunden.

Bezahlen Sie für Produkte und Abonnements

Erstellen Sie einen Wallet-Checkout, lassen Sie den Kunden ihn in ShareAI bestätigen und überprüfen Sie anschließend das bezahlte Ergebnis vor der Ausführung.

Beheben Sie Abrechnungsfehler und legen Sie Kundenausgabelimits fest

Unterscheiden Sie unzureichende Guthaben von einem Ausgabenlimit der Anwendung, präsentieren Sie einen akteursbewussten Wiederherstellungslink und behandeln Sie Streaming-Fehler korrekt.

ShareAI Plattform-Dokumentation
Alle Dokumentationen

Nach Titel oder Inhalt suchen.

Fragen zu dieser Seite

Wählen Sie einen Assistenten, um diese Seite zu erkunden. Sie können die Seite auch kopieren und in Ihr Gespräch einfügen.

Ask ChatGPTAsk ClaudeAsk GrokAsk ShareAI