Skip to content

Commit ed27df9

Browse files
committed
deploy repo readme
1 parent 3996bf1 commit ed27df9

File tree

1 file changed

+73
-4
lines changed

1 file changed

+73
-4
lines changed

README.md

Lines changed: 73 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,76 @@
1-
**Sonar Cookbook**
1+
# Sonar API Projects
22

3-
This Cookbook provides code and guides designed to help developers build with Sonar, offering code snippets that can easily be integrated into your own projects.
3+
A collection of practical applications and tools built with [Perplexity's Sonar API](https://sonar.perplexity.ai/), the fastest, most cost-effective AI answer engine with robust search capabilities.
44

5-
**Prerequisites**
5+
## ⚠️ API Key Required
66

7-
You'll need an API key (sign up by following the steps [here](https://docs.perplexity.ai/guides/getting-started))
7+
**Before you begin:** You'll need a Perplexity API key to use any project in this repository.
8+
9+
Sign up for an API key by following the steps in the [Perplexity documentation](https://docs.perplexity.ai/guides/getting-started).
10+
11+
## About This Repository
12+
13+
This repository contains various projects that demonstrate how to leverage Perplexity's Sonar API for different use cases. Each project is designed to showcase the API's capabilities while providing practical, ready-to-use tools for developers.
14+
15+
## Projects
16+
17+
### Fact Checker CLI
18+
19+
The flagship project in this collection is a command-line tool that analyzes claims or articles for factual accuracy. Using Sonar API's powerful search capabilities, it identifies false or misleading statements, provides corrections, and cites reliable sources.
20+
21+
[Read more about the Fact Checker CLI →](./fact-checker/README.md)
22+
23+
### Coming Soon
24+
25+
We're actively working on adding more projects to this collection:
26+
27+
- **Research Assistant**: Automated literature review and summarization tool
28+
- **News Analyzer**: Track developing stories and analyze reporting biases
29+
- **Content Verifier**: Browser extension for real-time fact checking
30+
- **Data Explorer**: Query and visualize complex datasets through natural language
31+
32+
## Why Sonar API?
33+
34+
Perplexity's Sonar API offers several advantages that make it ideal for building powerful AI applications:
35+
36+
- **Fast & Cost-Effective**: Get reliable answers at a fraction of the cost of other AI APIs
37+
- **Search Grounding**: Internet-connected models that can access and cite the latest information
38+
- **Easy Integration**: Simple, straightforward API that developers can integrate in minutes
39+
- **Scalable Pricing**: Pay-as-you-go model that scales with your usage
40+
41+
## Getting Started
42+
43+
To use any of the projects in this repository, you'll need:
44+
45+
1. A Perplexity API key (sign up [here](https://docs.perplexity.ai/guides/getting-started))
46+
3. Python 3.7+ installed on your system
47+
48+
Each project includes its own README with specific installation and usage instructions.
49+
50+
## API Access
51+
52+
You can sign up for Perplexity's Sonar API at [sonar.perplexity.ai](https://sonar.perplexity.ai/).
53+
54+
The API offers:
55+
- Free tier to get started
56+
- Straightforward documentation
57+
- Transparent usage-based pricing
58+
59+
## Contributing
60+
61+
Contributions to this repository are welcome! Whether you want to:
62+
63+
- Fix bugs in existing projects
64+
- Add new features to current tools
65+
- Contribute entirely new Sonar API projects
66+
- Improve documentation or examples
67+
68+
Please check the [CONTRIBUTING.md](./CONTRIBUTING.md) file for guidelines.
69+
70+
## License
71+
72+
Unless otherwise specified, all projects in this repository are licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.
73+
74+
---
75+
76+
*Build with the best AI answer engine. Power your products with the fastest, cheapest API offering out there with search grounding. Get started in minutes.*

0 commit comments

Comments
 (0)