BASE DE CONHECIMENTO

Referência da API

Autentique aplicações, gere texto e imagens, crie embeddings e automatize fluxos de trabalho de fornecedores, dispositivos e criadores.

Ver como Markdown

Comece aquiEscolha a API certa e compreenda os erros partilhados.ProgramadoresAutorização de aplicações, limites de gastos dos clientes, recuperação de faturação e integração de inferência.FornecedoresGere catálogos de providers e preços, depois controle dispositivos individuais.CriadoresAutenticação de creators, coleções, pacotes de modelos e etiquetas.

Faça sua primeira solicitação à API

Crie uma chave de API ShareAI, escolha um modelo disponível e envie uma solicitação de chat do seu servidor com autenticação Bearer.

Escolha a API e as credenciais certas

Encontre os endpoints da API ShareAI para autenticação de aplicações, chat, Respostas, embeddings, imagens, Providers, Devices e Creators, com o URL e credenciais corretos.

Regista a tua aplicação

Cria uma aplicação, escolhe o modelo de implementação e ativa apenas as capacidades do ShareAI de que necessita.

Autorizar uma conta com PKCE

Usa o código de autorização com S256 PKCE para aplicações confidenciais e públicas.

Escolha os âmbitos de Login, Pagamento e IA

O início de sessão, os pagamentos de produtos e os encargos adicionais de inferência requerem capacidades separadas e autorização do cliente.

Atualizar um token de acesso

Roda os tokens de atualização sem expandir os âmbitos autorizados pelo cliente.

Leia a identidade e descubra os endpoints de autenticação

Use a descoberta de autenticação ShareAI, JWKS e UserInfo para validar o início de sessão da aplicação e ler a identidade permitida por um token de acesso OAuth.

Revogue tokens e inspecione a autorização no lado do servidor

Revogue tokens de acesso e atualização não utilizados. Integrações confidenciais também podem inspecionar o estado dos tokens.

Compre os acordos de faturação aceites

Mantém o preço da subscrição, o intervalo e o encargo adicional de IA vinculados aos termos aceites por cada cliente.

Crie uma conclusão de chat

Envie um pedido de chat-completions do ShareAI com uma chave API Bearer e compreenda o modelo suportado, mensagens e campos de fluxo.

Envie solicitações de chat com OAuth

Use um token de acesso OAuth ShareAI aprovado para conclusões de chat financiadas pelo cliente e gerencie a expiração do token, consentimento e limites de conta.

Transmita uma resposta de chat

Leia eventos enviados pelo servidor de chat-completions do ShareAI, anexe deltas de conteúdo uma vez e gerencie conclusão, erros e fluxos interrompidos.

Inspecione o acesso à chave e a identidade da conta

Leia as informações da chave API ShareAI para verificar as restrições de modelo e fornecedor e a identidade da conta associada a uma credencial de inferência.

Criar uma resposta de texto

Use a API de Respostas do ShareAI para geração de texto sem estado, histórico explícito de conversas e eventos de streaming de Respostas.

Criar embeddings de texto

Gere embeddings de texto com ShareAI para pesquisa semântica, recuperação e similaridade, com formatos de entrada suportados e requisitos de modelo.

Gerar uma imagem

Crie imagens com a API de Imagens ShareAI utilizando um modelo suportado, um prompt de texto e opções de geração de imagem validadas.

Autentique a API do Provider

Ative o Acesso Remoto do Fornecedor e use um UUID de fornecedor e um token de acesso com escopo para solicitações de catálogo e preços.

Liste modelos do provider e da rede

Leia o catálogo de rede da ShareAI Provider API, o seu catálogo de provedores e os detalhes exatos dos modelos usando provider_models:read.

Atualize os preços dos modelos do provider

Defina os níveis de precificação de entrada, saída e cache do modelo do provider ShareAI usando um token de API do Provider com escopo e um identificador de modelo exato.

Autentique a API do Dispositivo

Crie um token de Controle Remoto específico para o dispositivo e compreenda as verificações de provider, dispositivo e estado habilitado para solicitações da ShareAI Device API.

Leia sessões de dispositivos e histórico de tarefas

Liste as sessões do dispositivo ShareAI e inspecione o histórico de tarefas de uma sessão usando um token de Controlo Remoto específico do dispositivo.

Inicie e pare o compartilhamento de dispositivos

Envie comandos de partilha de dispositivos ShareAI, distinga comandos aceites do estado observado e verifique o resultado na Console.

Autentique a API do Creator

Use credenciais de Acesso Remoto com escopo de creator e compreenda os escopos de coleção, modelo e configurações disponíveis na API ShareAI Creator.

Leia e gerencie coleções de modelos

Liste, crie e atualize coleções de modelos ShareAI Creator com os escopos necessários e limites claros de propriedade e revisão.

Crie um pacote de modelos

Crie metadados de modelo ShareAI Creator, uma coleção e etiquetas de modelo juntos, com política de acesso explícita e credenciais de API delimitadas.

Gerencie modelos dentro de uma coleção

Liste, leia, crie e atualize etiquetas de modelo do ShareAI Creator enquanto preserva a propriedade da coleção e a política de serviço efetiva.

Lide com erros e repetições da API

Diagnostique erros de autenticação, escopo, acesso a modelos e disponibilidade do ShareAI sem duplicar gravações ou tentar atualizações inseguras.

Compreender os criadores de modelos, identificadores e etiquetas

Escolhe um identificador de modelo ShareAI baseado no criador, explora a sua família e compara os fornecedores que o podem executar.

Escolher fornecedores de execução para um pedido de API

Utilize o objeto de fornecedor ShareAI para selecionar fornecedores de execução independentemente do criador de um modelo em todos os quatro endpoints de inferência.

Referência de política de fornecedores

Consulte os campos, padrões, limites e erros do fornecedor ShareAI para escolher fornecedores de execução em pedidos de inferência.

Ordenar fornecedores e controlar fallback

Compreenda o ranking de preço, latência e throughput do ShareAI, fornecedores ordenados, medições indisponíveis e limites seguros de fallback.

Compreenda as identidades dos clientes

Cada cliente OAuth recebe um identificador diferente para o mesmo cliente ShareAI.

Pague por produtos e subscrições

Crie um checkout de carteira, deixe o cliente confirmá-lo no ShareAI e, em seguida, verifique o resultado pago antes da execução.

Gerir erros de faturação e limites de gastos dos clientes

Diferencie créditos insuficientes de um limite de gastos da aplicação, apresente um link de recuperação sensível ao ator e trate falhas de streaming corretamente.