perplexity_flutter 2.0.4

A lightweight Flutter SDK to interact with Perplexity.ai's chat completion API (streaming + model switching supported).

perplexity_flutter

Perplexity Flutter SDK is a lightweight and type-safe Dart client for interacting with Perplexity.ai's chat/completions API.
It supports both streaming and non-streaming responses, flexible model switching (e.g., sonar, sonar-pro, etc.), and is designed to work with Flutter apps.

This package is built on top of perplexity_dart, which provides the core API layer. If you only need API access without Flutter UI components, consider using perplexity_dart directly for a more lightweight solution. Perplexity Flutter wraps the API layer with easy-to-use Flutter widgets for faster development.

---

Features

• Streamed and full chat completion support
• Switch between models with known context lengths
• Chat roles: system, user, assistant, tool
• BLoC integration for Flutter apps
• Ready-to-use Flutter widgets for chat UI
• Coming soon: Image input via base64 or HTTPS URL

---

Getting Started

Add the SDK to your project:

dependencies:
  perplexity_flutter: 

Flutter Widgets

The SDK provides ready-to-use widgets for quick integration into your Flutter app:

import 'package:flutter/material.dart';
import 'package:perplexity_flutter/perplexity_flutter.dart';

void main() => runApp(const MyApp());

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Perplexity Example',
      home: ChatWrapperWidget(
        apiKey: 'your-api-key',
        model: PerplexityModel.sonar,
        child: const ChatScreen(),
      ),
    );
  }
}

class ChatScreen extends StatelessWidget {
  const ChatScreen({super.key});

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: const Text('Perplexity Chat')),
      body: Column(
        children: [
          const Expanded(child: PerplexityChatView()),
          PerplexityChatInput(),
        ],
      ),
    );
  }
}

Direct API Usage

For more control, you can use the PerplexityClient directly:

import 'package:perplexity_flutter/perplexity_flutter.dart';

void main() async {
  final client = PerplexityClient(
    apiKey: 'your-api-key',
  );
  
  // Create messages
  final messages = [
    MessageModel(
      role: MessageRole.system,
      content: 'Be precise and concise.',
    ),
    MessageModel(
      role: MessageRole.user,
      content: 'Hello, how are you?',
    ),
  ];
  
  // Non-streaming response
  final requestModel = ChatRequestModel(
    model: PerplexityModel.sonarPro,
    messages: messages,
    stream: false,
  );
  
  final response = await client.sendMessage(requestModel: requestModel);
  print(response.content);
  
  // Streaming response
  final streamRequestModel = ChatRequestModel(
    model: PerplexityModel.sonar,
    messages: messages,
    stream: true,
  );
  
  final stream = client.streamChat(requestModel: streamRequestModel);
  
  await for (final chunk in stream) {
    print(chunk);
  }
}

Available Models

The SDK supports all current Perplexity models with their context lengths:

• PerplexityModel.sonar - 128K tokens
• PerplexityModel.sonarPro - 200K tokens
• PerplexityModel.sonarDeepResearch - 128K tokens
• PerplexityModel.sonarReasoning - 128K tokens
• PerplexityModel.sonarReasoningPro - 128K tokens

Advanced Configuration

The ChatRequestModel supports various parameters for fine-tuning your requests:

final requestModel = ChatRequestModel(
  model: PerplexityModel.sonar,
  messages: messages,
  stream: true,
  maxTokens: 1000,
  temperature: 0.7,
  topP: 0.9,
  searchDomainFilter: ['example.com'],
  returnImages: false,
  returnRelatedQuestions: true,
  searchRecencyFilter: 'day',
  topK: 3,
  presencePenalty: 0.0,
  frequencyPenalty: 0.0,
);

License

This project is licensed under the MIT License - see the LICENSE file for details.