Skip to main content
Documentation
StartOverviewArchitectureAuthenticationSend your first message
TypeScript SDKOverviewTrusted app serverApp-user clientsRealtimeErrors & webhooks
Flutter SDKOverviewInstallationAuthenticationChannels & messagesOffline & syncRealtimeUI componentsPush & lifecycle
ConceptsTenancy & scopeChannels & messagesDelivery & reconciliationSecurity checklist
ProtocolsRealtimeSigned webhooks
ReferenceREST APIErrors, limits & retriesDeploy docs to Coolify
VV ChatDocs API v1
Recommended starting points
Build chat without rebuilding infrastructureV Chat is a multi-tenant messaging backend with typed server, web, and Flutter integration paths.StartArchitecture at a glanceUnderstand the control plane, data plane, realtime path, and SDK boundaries before integrating.StartAuthentication and credentialsSelect the correct credential for dashboard, trusted-server, app-user, realtime, and webhook flows.StartSend your first messageUse the trusted TypeScript server client to create the minimum safe messaging flow.StartTypeScript SDK overviewChoose the correct typed client for trusted servers, app users, dashboard sessions, realtime, and webhooks.TypeScript SDKTrusted app-server clientUse AppServerClient from a protected backend to manage data-plane resources and mint app-user tokens.TypeScript SDKApp-user clientsBuild browser or Node app-user flows with VChatClient or the lower-level AppUserClient.TypeScript SDK
↑↓ Navigate↵ Openesc Close
API reference
StartOverviewArchitectureAuthenticationSend your first message
TypeScript SDKOverviewTrusted app serverApp-user clientsRealtimeErrors & webhooks
Flutter SDKOverviewInstallationAuthenticationChannels & messagesOffline & syncRealtimeUI componentsPush & lifecycle
ConceptsTenancy & scopeChannels & messagesDelivery & reconciliationSecurity checklist
ProtocolsRealtimeSigned webhooks
ReferenceREST APIErrors, limits & retriesDeploy docs to Coolify
Contract sourceOpenAPI JSON
Docs/Flutter SDK
Quickstart

Install the Flutter SDK

Add the recommended package, implement a token provider, and create one SDK per app-user session.

Updated 2026-08-09•sdks/flutter/packages/v_chat_flutter/README.md · v_chat_sdk/README.md

Requirements

  • Flutter 3.38 or newer for the released v_chat_flutter candidate.
  • Dart 3.10 or newer and below Dart 4.
  • A V Chat application ID and HTTPS API base URL.
  • An authenticated endpoint on your backend that returns a short-lived app-user token.

Add the dependency

bash
# Client + lifecycle + persistence, build your own UI
flutter pub add v_chat_flutter

# Or the complete umbrella with optional widgets
flutter pub add v_chat_sdk
Pin an approved release candidate

Use the exact package version approved by your team and review its changelog. The repository sources may be newer than a registry package.

Create and connect the SDK

dart
import 'package:v_chat_flutter/v_chat_flutter.dart';

final sdk = await VChatFlutterSdk.create(
  options: VChatClientOptions(
    appId: '00000000-0000-4000-8000-000000000001',
    apiBaseUri: Uri.parse('https://api.example.com'),
  ),
  tokenProvider: const BackendTokenProvider(),
  databaseName: 'vchat-current-profile',
);

sdk.lifecycleBinding.attach();
await sdk.client.connectUser(userId: currentUserId);
final conversations = await sdk.client.queryCurrentUserConversations(
  limit: 25,
);
renderConversations(conversations.items);

Create one SDK per logical app-user session. Plain HTTP is rejected unless explicitly enabled for a loopback development endpoint.

Disconnect and dispose

dart
try {
  await runAuthenticatedChatSession(sdk.client);
} finally {
  await sdk.client.disconnect();
  await sdk.dispose();
}

Dispose all stream subscriptions, controllers, and focus nodes owned by your application. The SDK closes only the resources it owns.

PreviousFlutter SDK overviewNext Flutter authentication
On this pageRequirementsAdd the dependencyCreate and connect the SDKDisconnect and dispose
Report a docs issue