ShvIA
TIMELINE
ACESSAR

Docs · Comece aqui

Documentação para desenvolvedores do ShvIA

O ShvIA é um gateway de IA: uma conta, uma chave de API e um registro de uso na frente de modelos que rodam nas GPUs do operador e em provedores de nuvem. Esta documentação cobre a API HTTP que você usa para chamá-lo do seu código e das suas ferramentas.

O serviço hospedado fica em https://ai.shvia.org, e https://ia.shvia.org serve a mesma aplicação. Todos os exemplos aqui usam o primeiro endereço.

Três formas de entrar#

As três usam a mesma chave de API, e as chamadas de chat delas são medidas juntas.

SuperfícieEndpointsUse quando
Compatível com OpenAI/v1/chat/completions, /v1/responses, /v1/models, /v1/audio/*sua ferramenta ou SDK já fala a API da OpenAI
Compatível com Anthropic/v1/messagessua ferramenta ou SDK fala a API Messages da Anthropic, como o Claude Code
Nativa/api/v1/*você quer o que os apps do ShvIA usam: conversas guardadas, anexos, esforço de raciocínio, uso e custo

O que o gateway acrescenta#

  • Uma chave para muitos modelos. Modelos nas GPUs do operador e em provedores de nuvem compartilham uma lista de modelos e um formato de requisição.
  • Suas próprias chaves de provedor. Para modelos de nuvem você traz a sua chave do provedor (BYOK), então o contrato e a conta ficam entre você e o provedor. Veja provedores e suas chaves.
  • Contabilidade por resposta. Cada chamada de chat é medida em tokens e tempo, contra limites definidos por grupo de conta. Embeddings e áudio não são medidos. Veja uso e custo e limites e cotas.
  • Um caminho de dados declarado. Cada modelo declara se o prompt fica na infraestrutura do operador ou sai dela. Veja seus dados.

Comece aqui#

API compatível com OpenAI#

  • Modelos: GET /v1/models, ids de modelo e como achar os modelos que você realmente pode usar.
  • Chat completions: POST /v1/chat/completions, com streaming e chamadas de ferramenta.
  • Responses: POST /v1/responses, a fatia sem estado.
  • Áudio: voz para texto e texto para voz.

API compatível com Anthropic#

  • Messages: POST /v1/messages e contagem de tokens.

API nativa#

  • Chat em stream: POST /api/v1/chat por server-sent events, e o POST /api/v1/agent/chat síncrono.
  • Conversas: liste, leia, exporte e apague conversas guardadas.
  • Embeddings: POST /api/v1/embeddings.
  • Coleções: envie seus próprios documentos uma vez e nomeie-os numa chamada de chat para o modelo responder a partir deles.
  • Uso e custo: janelas de cota, gasto por provedor e custo por conversa.

Referência#

  • Erros: os formatos de erro de cada superfície e o que repetir.
  • Limites e cotas: limites de requisições, tetos de tokens e como lê-los.

Protocolos#

Guias#