Guias
SDKs
Um único SDK publicado, o widget Flutter, além de uma API REST e uma especificação OpenAPI que você pode chamar de qualquer linguagem.
O AskAIs adota uma abordagem protocolo em primeiro lugar: uma única especificação OpenAPI 3.1, um único protocolo WebSocket e webhooks assinados com HMAC. Você pode chamar a API a partir de qualquer linguagem e renderizar sua própria interface. Hoje publicamos um único SDK de interface empacotado, o widget Flutter nativo.
O SDK publicado: o widget Flutter
O único SDK que entregamos hoje fica em sdks/flutter-widget/. É uma interface de chat completa e personalizável que se comunica por você com a API REST e o WebSocket. Adicione-o ao seu pubspec.yaml como um pacote local:
# pubspec.yaml
dependencies:
singchat_widget:
path: ../sdks/flutter-widgetiOS e Android
Não há um SDK nativo separado para iOS ou Android. Dois caminhos são suportados:
- WebView (recomendado), carregue o widget Web a partir de
/api/widget-embed. É o widget completo e se atualiza automaticamente, então você nunca precisa publicar uma versão do aplicativo apenas para obter novos recursos de chat. - API REST, chame a API diretamente e renderize sua própria interface nativa.
Não há visualizações de chat prontas em SwiftUI nem em Jetpack Compose. Você incorpora o WebView ou constrói a interface você mesmo sobre a API.
Qualquer outra linguagem: chame a API REST
Não fornecemos clientes pré-compilados para Python, Go, Rust, C#, Java, PHP, Ruby ou semelhantes, e não há SDKs oficiais de React Native, Unity ou Unreal. Em vez disso, há uma API REST pública com uma especificação OpenAPI 3.1, que você pode chamar via HTTP puro ou para a qual gerar seu próprio cliente:
- OpenAPI:
GET /api/v1/openapi.json - WebSocket: consulte a documentação do widget Web para o JSON de eventos
Gere um cliente para a linguagem desejada com o openapi-generator:
# generate a client from the public spec
npx @openapitools/openapi-generator-cli generate \
-i https://singchat.org/api/v1/openapi.json \
-g python \
-o ./singchat-clientO que o AskAIs oferece
Além do widget, estes recursos do produto já estão disponíveis hoje:
- Caixa de entrada unificada no widget Web, Telegram e WhatsApp, com um espaço para X (Twitter) pronto.
- IA hospedada na plataforma: sem necessidade de chave de API, cobrança por token com recarga automática e encaminhamento para humano, ou use sua própria chave.
- Centro de Treinamento de IA: rastreie seu site, envie arquivos PDF, Word ou DOCX, adicione pares de perguntas e respostas de um CSV e ensaie em um Playground antes do lançamento.
- Central de ajuda em 50 idiomas para artigos de autoatendimento e FAQ.
- Marca branca completa em todas as superfícies voltadas para o cliente.
- Entrega multidomínio antibloqueio para o widget.
Exemplos rápidos
Flutter widget
import 'package:singchat_widget/singchat_widget.dart';
// mount the themeable chat UI
SingChatWidget(
appId: 'ws_abc123',
user: SingChatUser(
externalId: 'user_42',
email: 'ada@example.com',
),
)iOS WebView
import WebKit
let webView = WKWebView(frame: view.bounds)
let url = URL(string: "https://singchat.org/api/widget-embed?appId=ws_abc123")!
webView.load(URLRequest(url: url))
view.addSubview(webView)Android WebView
val webView = WebView(this)
webView.settings.javaScriptEnabled = true
webView.loadUrl("https://singchat.org/api/widget-embed?appId=ws_abc123")
setContentView(webView)curl puro
# identify against the REST API (any language, no library)
curl https://singchat.org/api/v1/auth/identify \
-H "Content-Type: application/json" \
-d '{ "appId": "ws_abc123", "email": "ada@example.com" }'