Skip to content

Commit 0773cac

Browse files
author
souzatharsis
committed
update docs
1 parent 774836a commit 0773cac

File tree

2 files changed

+11
-5
lines changed

2 files changed

+11
-5
lines changed

usage/config.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,17 @@ The project uses a combination of a `.env` file for managing API keys and sensit
1212
ELEVENLABS_API_KEY=your_elevenlabs_api_key_here
1313
OPENAI_API_KEY=your_openai_api_key_here
1414
```
15-
API Key Requirements:
16-
- `GEMINI_API_KEY`: Required for transcript generation if not using a [local llm](local_llm.md). (get your [free API key](aistudio.google.com/app/apikey))
17-
- `OPENAI_API_KEY` or `ELEVENLABS_API_KEY`: Required for audio generation if not using Microsoft Edge TTS `tts_model=edge`.
15+
## API Key Requirements
1816

19-
Ensure you have the necessary API keys based on your intended usage of Podcastfy.
17+
The API Keys required depend on the model you are using for transcript generation and audio generation.
18+
19+
- Transcript generation (LLMs):
20+
- By default, Podcastfy uses Google's `gemini-1.5-pro-latest` model. Hence, you need to set `GEMINI_API_KEY`.
21+
- See how to configure other LLMs [here](how-to.md#custom-llm-support).
22+
23+
- Audio generation (TTS):
24+
- By default, Podcastfy uses OpenAI TTS. Hence, you need to set `OPENAI_API_KEY`.
25+
- Additional supported models are ElevenLabs ('elevenlabs'), Microsoft Edge ('edge') and Google TTS ('gemini'). All but Edge require an API key.
2026

2127
> [!Note]
2228
> Never share your `.env` file or commit it to version control. It contains sensitive information that should be kept private. The `config.yaml` file can be shared and version-controlled as it doesn't contain sensitive data.

usage/how-to.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Podcastfy offers a range of LLM models for generating transcripts including Open
1818

1919
### Cloud-based LLMs
2020

21-
By default, Podcastfy uses Google's `gemini-1.5-pro-latest` model. To select a particular cloud-based LLM model, users can pass the `llm_model_name` and `api_key_label` parameters to the `generate_podcast` function.
21+
By default, Podcastfy uses Google's `gemini-1.5-pro-latest` model. To select a particular cloud-based LLM model, users can pass the `llm_model_name` and `api_key_label` parameters to the `generate_podcast` function. See [full list of supported models](https://docs.litellm.ai/docs/providers) for more details.
2222

2323
For example, to use OpenAI's `gpt-4-turbo` model, users can pass `llm_model_name="gpt-4-turbo"` and `api_key_label="OPENAI_API_KEY"`.
2424

0 commit comments

Comments
 (0)