BASE DE CONNAISSANCES

Référence API

Authentifiez des applications, générez du texte et des images, créez des embeddings et automatisez les workflows de fournisseurs, appareils et créateurs.

Voir en Markdown

Commencez iciChoisissez la bonne API et comprenez les erreurs partagées.DéveloppeursAutorisation des applications, limites de dépenses des clients, récupération de facturation et intégration des inférences.FournisseursGérez les catalogues des providers et les tarifs, puis contrôlez les devices individuellement.CréateursAuthentification des creators, collections, packages de modèles et tags.

Effectuez votre première requête API

Créez une clé API ShareAI, choisissez un modèle disponible et envoyez une requête de chat depuis votre serveur avec une authentification Bearer.

Choisissez l'API et les identifiants appropriés

Trouvez les points de terminaison de l'API ShareAI pour l'authentification des applications, le chat, les Réponses, les embeddings, les images, les Providers, les Devices et les Creators, avec l'URL et les identifiants corrects.

Enregistrez votre application

Créez une application, choisissez son modèle de déploiement et activez uniquement les fonctionnalités ShareAI dont elle a besoin.

Autorisez un compte avec PKCE

Utilisez le code d'autorisation avec S256 PKCE pour les applications confidentielles et publiques.

Choisissez les portées de connexion, de paiement et d'IA

La connexion, les paiements de produits et les surcharges d'inférence nécessitent des fonctionnalités distinctes et l'autorisation du client.

Actualiser un jeton d'accès

Faites tourner les jetons de rafraîchissement sans élargir les autorisations acceptées par le client.

Lisez l'identité et découvrez les points de terminaison Auth

Utilisez la découverte d'authentification ShareAI, JWKS et UserInfo pour valider la connexion de l'application et lire l'identité autorisée par un jeton d'accès OAuth.

Révoquez les jetons et inspectez l'autorisation côté serveur

Révoquez les jetons d'accès et de rafraîchissement inutilisés. Les intégrations confidentielles peuvent également inspecter l'état des jetons.

Comprendre les accords de facturation acceptés

Maintenez le prix de l'abonnement, l'intervalle et la surcharge AI liés aux conditions acceptées par chaque client.

Créez une complétion de chat

Envoyez une requête de complétions de chat ShareAI avec une clé API Bearer et comprenez les champs pris en charge pour le modèle, les messages et le flux.

Envoyez des requêtes de chat avec OAuth

Utilisez un jeton d'accès OAuth ShareAI approuvé pour les complétions de chat financées par le client et gérez l'expiration du jeton, le consentement et les limites de compte.

Diffusez une réponse de chat

Lisez les événements envoyés par le serveur pour les complétions de chat ShareAI, ajoutez les deltas de contenu une fois et gérez les complétions, les erreurs et les flux interrompus.

Inspectez l'accès aux clés et l'identité du compte

Lisez les informations sur la clé API ShareAI pour vérifier les restrictions de modèle et de fournisseur ainsi que l'identité du compte associée à un identifiant d'inférence.

Créer une réponse textuelle

Utilisez l'API ShareAI Responses pour la génération de texte sans état, l'historique explicite des conversations et les événements de streaming Responses.

Créer des embeddings textuels

Générez des embeddings textuels avec ShareAI pour la recherche sémantique, la récupération et la similarité, avec des formats d'entrée pris en charge et des exigences de modèle.

Générer une image

Créez des images avec l'API Images de ShareAI en utilisant un modèle pris en charge, une invite textuelle et des options de génération d'images validées.

Authentifiez l'API du fournisseur

Activez l'accès à distance du fournisseur et utilisez un UUID de fournisseur ainsi qu'un jeton d'accès limité pour les demandes de catalogue et de tarification.

Listez les modèles du fournisseur et du réseau

Lisez le catalogue réseau de l'API Provider ShareAI, votre catalogue de fournisseurs et les détails exacts des modèles en utilisant provider_models:read.

Mettez à jour les tarifs des modèles du fournisseur

Définissez les niveaux de tarification d'entrée, de sortie et de cache des modèles de fournisseurs ShareAI à l'aide d'un jeton API Provider avec portée et d'un identifiant de modèle exact.

Authentifiez l'API de l'appareil

Créez un jeton de contrôle à distance spécifique à un appareil et comprenez les vérifications de fournisseur, d'appareil et d'état activé pour les requêtes API Device de ShareAI.

Consultez les sessions d'appareil et l'historique des tâches

Lister les sessions des appareils ShareAI et inspecter l'historique des tâches d'une session à l'aide d'un jeton de contrôle à distance spécifique à l'appareil.

Démarrez et arrêtez le partage d'appareil

Envoyez des commandes de partage d'appareil ShareAI, distinguez les commandes acceptées de l'état observé et vérifiez le résultat dans la Console.

Authentifiez l'API du créateur

Utilisez des identifiants d'accès à distance limités au Creator et comprenez les portées de collection, de modèle et de paramètres disponibles dans l'API ShareAI Creator.

Consultez et gérez les collections de modèles

Listez, créez et mettez à jour les collections de modèles ShareAI Creator avec les portées requises et des limites claires de propriété et de révision.

Créez un package de modèle

Créez les métadonnées du modèle ShareAI Creator, une collection et des balises de modèle ensemble, avec une politique d'accès explicite et des identifiants API à portée limitée.

Gérez les modèles au sein d'une collection

Listez, lisez, créez et mettez à jour les balises de modèle ShareAI Creator tout en préservant leur appartenance à la collection et leur politique de service effective.

Gérez les erreurs et les nouvelles tentatives de l'API

Diagnostiquez les erreurs d'authentification, de portée, d'accès aux modèles et de disponibilité ShareAI sans écritures en double ni tentatives de rafraîchissement non sécurisées.

Comprendre les créateurs de modèles, les identifiants et les balises

Choisissez un identifiant de modèle ShareAI précis basé sur le créateur, explorez sa famille et comparez les fournisseurs capables de l'exécuter.

Choisir des fournisseurs d'exécution pour une requête API

Utilisez l'objet fournisseur ShareAI pour sélectionner des fournisseurs d'exécution indépendamment du créateur d'un modèle sur les quatre points de terminaison d'inférence.

Référence des politiques des fournisseurs

Référencez les champs, valeurs par défaut, limites et erreurs des fournisseurs ShareAI pour choisir les fournisseurs d'exécution dans les requêtes d'inférence.

Trier les fournisseurs et contrôler les solutions de repli

Comprendre le classement des prix, de la latence et du débit de ShareAI, les fournisseurs ordonnés, les mesures indisponibles et les limites de secours sûres.

Comprenez les identités des clients

Chaque client OAuth reçoit un identifiant différent pour le même client ShareAI.

Payer pour les produits et abonnements

Créez un paiement via portefeuille, laissez le client le confirmer dans ShareAI, puis vérifiez le résultat payé avant l'exécution.

Gérer les erreurs de facturation et les limites de dépenses des clients

Distinguez les crédits insuffisants d'une limite de dépenses d'application, présentez un lien de récupération adapté à l'utilisateur et gérez correctement les échecs de streaming.