From 82bac5547cf37fec616aadbd3ffad65cff5177c0 Mon Sep 17 00:00:00 2001 From: Pierre Date: Tue, 8 Apr 2025 16:04:08 -0700 Subject: [PATCH 1/2] docs: add API key setup instructions to README --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 1f2841f..97c78db 100644 --- a/README.md +++ b/README.md @@ -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: From ad7b21a8328a9fcbf9ba05a0e34070f08cb89f5f Mon Sep 17 00:00:00 2001 From: Pierre Date: Tue, 8 Apr 2025 20:20:47 -0700 Subject: [PATCH 2/2] docs: add acknowledgments section to README --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 97c78db..95ae911 100644 --- a/README.md +++ b/README.md @@ -178,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! ✨ \ No newline at end of file