Referencia de API
Autentica aplicaciones, genera texto e imágenes, crea embeddings y automatiza flujos de trabajo de proveedores, dispositivos y creadores.
Realiza tu primera solicitud a la API
Crea una clave API de ShareAI, elige un modelo disponible y envía una solicitud de chat desde tu servidor con autenticación Bearer.
Elige la API y las credenciales correctas
Encuentra los endpoints de la API de ShareAI para la autenticación de aplicaciones, chat, Respuestas, embeddings, imágenes, Providers, Devices y Creators, con la URL y credenciales correctas.
Operaciones de inferencia y unidades de facturación
Elige el endpoint de ShareAI, las capacidades y las unidades de precios correctas para cada tipo de modelo.
Generar imágenes
La respuesta JSON sincrónica contiene resultados de imágenes en los datos.
Registrar su aplicación
Crea una aplicación, elige su modelo de implementación y habilita solo las capacidades de ShareAI que necesita.
Generar videos
La presentación devuelve HTTP 202 con un ID de trabajo de ShareAI y una URL de sondeo.
Generar voz
La respuesta exitosa es audio binario, no JSON.
Transcribir audio
Proporcione audio en base64 en input_audio.data y su formato real.
Toma decisiones estructuradas
Usa el endpoint estable de ShareAI /api/v1/decisions.
Reordenar documentos
Proporcione una consulta y de 1 a 1000 documentos.
Generar audio
El endpoint de ShareAI devuelve un resultado de audio en JSON delimitado.
Autoriza una cuenta con PKCE
Usa el código de autorización más S256 PKCE para aplicaciones confidenciales y públicas.
Elige los alcances de Inicio de sesión, Pago e IA
Los recargos de Inicio de sesión, producto payments y inference requieren capacidades separadas y autorización del cliente.
Actualizar un token de acceso
Rotar tokens de actualización sin expandir los alcances autorizados del cliente.
Lee la identidad y descubre los endpoints de autenticación
Usa el descubrimiento de autenticación de ShareAI, JWKS y UserInfo para validar el inicio de sesión de la aplicación y leer la identidad permitida por un token de acceso OAuth.
Revoca tokens e inspecciona la autorización del lado del servidor
Revoca los tokens de acceso y actualización no utilizados. Las integraciones confidenciales también pueden inspeccionar el estado de los tokens.
Comprende los acuerdos de facturación aceptados
Mantén el precio de la suscripción, el intervalo y el margen Builder vinculados a los términos que cada cliente aceptó.
Crea una completación de chat
Envía una solicitud de chat-completions de ShareAI con una clave API Bearer y comprende el modelo compatible, los mensajes y los campos de flujo.
Envía solicitudes de chat con OAuth
Usa un token de acceso OAuth aprobado de ShareAI para finalizaciones de chat financiadas por el cliente y maneja la expiración del token, el consentimiento y los límites de cuenta.
Transmite una respuesta de chat
Lee los eventos enviados por el servidor de completaciones de chat de ShareAI, agrega los deltas de contenido una vez y maneja la finalización, errores y flujos interrumpidos.
Inspecciona el acceso clave y la identidad de la cuenta
Lee la información de la clave API de ShareAI para verificar las restricciones de modelo y proveedor, y la identidad de la cuenta asociada con una credencial de inferencia.
Crear una respuesta de texto
Usa la API de Respuestas de ShareAI para generación de texto sin estado, historial explícito de conversaciones y eventos de transmisión de Respuestas.
Crear embeddings de texto
Genera embeddings de texto con ShareAI para búsqueda semántica, recuperación y similitud, con formatos de entrada compatibles y requisitos de modelos.
Generar una imagen
Crea imágenes con la API de Imágenes de ShareAI utilizando un modelo compatible, un texto de entrada y opciones de generación de imágenes validadas.
Autentica la API de Proveedor
Habilita el Acceso Remoto del Proveedor y usa un UUID de proveedor y un token de acceso limitado para solicitudes de catálogo y precios.
Lista modelos de proveedor y de red
Lee el catálogo de red de la API de Proveedor de ShareAI, tu catálogo de proveedor y los detalles exactos del modelo utilizando provider_models:read.
Actualiza los precios del modelo del proveedor
Configura los niveles de precios de entrada, salida y caché del modelo del proveedor de ShareAI utilizando un token de API de Proveedor con alcance y un identificador de modelo exacto.
Autentica la API de Dispositivo
Crea un token de Control Remoto específico para el dispositivo y comprende las verificaciones de proveedor, dispositivo y estado habilitado para las solicitudes de la API de Dispositivos de ShareAI.
Lee sesiones de dispositivos e historial de tareas
Lista de sesiones de dispositivos ShareAI e inspección del historial de tareas de una sesión utilizando un token de Control Remoto específico del dispositivo.
Inicia y detén el uso compartido de dispositivos
Envía comandos de compartición de dispositivos ShareAI, distingue los comandos aceptados del estado observado y verifica el resultado en la Consola.
Autentica la API de Creador
Usa credenciales de Acceso Remoto con alcance de Creator y comprende los alcances de colección, modelo y configuración disponibles en la API de ShareAI Creator.
Lee y gestiona colecciones de modelos
Lista, crea y actualiza colecciones de modelos de ShareAI Creator con los alcances requeridos y límites claros de propiedad y revisión.
Crea un paquete de modelos
Crea metadatos de modelo de ShareAI Creator, una colección y etiquetas de modelo juntos, con una política de acceso explícita y credenciales de API delimitadas.
Gestiona modelos dentro de una colección
Lista, lee, crea y actualiza etiquetas de modelo de ShareAI Creator mientras preservas la propiedad de la colección y la política efectiva de servicio.
Maneja errores y reintentos de la API
Diagnostica errores de autenticación, alcance, acceso a modelos y disponibilidad de ShareAI sin escrituras duplicadas ni reintentos de actualización inseguros.
Comprender creadores de modelos, identificadores y etiquetas
Elige un identificador de modelo de ShareAI basado en el creador, explora su familia y compara los proveedores que pueden ejecutarlo.
Elegir proveedores de ejecución para una solicitud de API
Usa el objeto de proveedor de ShareAI para seleccionar proveedores de ejecución independientemente del creador de un modelo en los cuatro puntos finales de inferencia.
Referencia de políticas de proveedores
Consulta los campos, valores predeterminados, límites y errores del proveedor de ShareAI para elegir proveedores de ejecución en solicitudes de inferencia.
Ordenar proveedores y controlar la alternativa
Comprende el precio, la latencia y el ranking de rendimiento de ShareAI, proveedores ordenados, mediciones no disponibles y límites de respaldo seguros.
Comprende las identidades de los clientes
Cada cliente OAuth recibe un identificador diferente para el mismo cliente de ShareAI.
Pagar por productos y suscripciones
Crear un checkout de wallet, permitir que el cliente lo confirme en ShareAI, luego verificar el resultado pagado antes de la ejecución.
Maneja errores de facturación y límites de gasto del cliente
Distingue créditos insuficientes de un límite de gasto de la aplicación, presenta un enlace de recuperación consciente del actor y maneja correctamente los fallos de transmisión.