|
1 |
| -# Hume API Examples |
| 1 | +<div align="center"> |
| 2 | + <img src="https://storage.googleapis.com/hume-public-logos/hume/hume-banner.png"> |
| 3 | + <h1>Hume API Examples</h1> |
| 4 | + <p> |
| 5 | + <strong>Browse sample code and projects designed to help you integrate Hume APIs</strong> |
| 6 | + </p> |
| 7 | + <p> |
| 8 | + <a href="https://docs.hume.ai">📘 Documentation</a> • |
| 9 | + <a href="https://discord.com/invite/humeai">💬 Join us on Discord</a> • |
| 10 | + <a href="https://dev.hume.ai/docs/introduction/api-key">🔐 Getting your API Keys</a> |
| 11 | + </p> |
| 12 | +</div> |
2 | 13 |
|
3 |
| -This repository contains examples of how to use the [Hume API](https://docs.hume.ai) with different frameworks and languages. |
| 14 | +## Overview |
| 15 | + |
| 16 | +Welcome to the official Hume API Examples repository! |
| 17 | +Here you'll find open-source example projects and quickstart guides to help you integrate the [Hume API](https://docs.hume.ai) across a variety of languages and frameworks. |
| 18 | + |
| 19 | +Use these examples to: |
| 20 | + |
| 21 | +- Add empathic Text-to-Speech (TTS) to your application |
| 22 | +- Build rich conversational agents with the Empathic Voice Interface (EVI) |
| 23 | +- Measure expressions with facial, vocal, and language-based analysis |
| 24 | + |
| 25 | +Whether you're using Python, TypeScript, Flutter, or Next.js, there's something here to help you get started quickly. |
4 | 26 |
|
5 | 27 | ## [Text-to-Speech (TTS)](https://dev.hume.ai/docs/text-to-speech-tts/overview)
|
6 | 28 |
|
@@ -43,3 +65,15 @@ This repository contains examples of how to use the [Hume API](https://docs.hume
|
43 | 65 | | [`next-js-emotional-language`](/expression-measurement/batch/next-js-emotional-language/README.md) | `language` | TypeScript | Next.js |
|
44 | 66 | | [`next-js-streaming-example`](/expression-measurement/streaming/next-js-streaming-example/README.md) | `language`, `face`, `burst`, `speech` | TypeScript | Next.js |
|
45 | 67 |
|
| 68 | +## Authentication & Setup |
| 69 | + |
| 70 | + You must authenticate to use the Hume API. Your API key can be retrieved from the [Hume AI platform](https://platform.hume.ai/settings/keys). For detailed instructions, see our documentation on [getting your api keys](https://dev.hume.ai/docs/introduction/api-key). |
| 71 | + |
| 72 | + Each example project includes a `README.md` file with step-by-step instructions on: |
| 73 | + - Setting your API key (usually via environment variables) |
| 74 | + - Installing dependencies |
| 75 | + - Running the example |
| 76 | + |
| 77 | +## License |
| 78 | + |
| 79 | +All projects are licensed under the MIT License - see the [LICENSE.txt](/LICENSE) file for details. |
0 commit comments