Skip to content

docs: add API key setup instructions to README #82

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pierrevalade merged 2 commits into from
Apr 9, 2025
Merged

docs: add API key setup instructions to README #82

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
82bac55
docs: add API key setup instructions to README
pierrevalade Apr 8, 2025
ad7b21a
docs: add acknowledgments section to README
pierrevalade Apr 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,18 @@ This SDK is designed for Python teams who prefer code-first development. It prov
pip install workflowai
```

### API Key

To get started quickly, get an API key from [WorkflowAI Cloud](https://workflowai.com/organization/settings/api-keys). For maximum control over your data, you can also use your [self-hosted instance](https://github.com/WorkflowAI/workflowai), though this requires additional setup time.

Then, set the `WORKFLOWAI_API_KEY` environment variable:

```sh
export WORKFLOWAI_API_KEY="your-api-key"
```

### First Agent

Here's a simple example of a WorkflowAI agent that extracts structured flight information from email content:


Expand Down Expand Up @@ -166,3 +178,7 @@ For advanced workflow patterns and examples, please refer to the [Workflows READ
## Contributing

See the [CONTRIBUTING.md](./CONTRIBUTING.md) file for more details. Thank you!

## Acknowledgments

Thanks to [ell](https://github.com/MadcowD/ell) for the inspiration! ✨