Skip to content

Commit 99c3e9f

Browse files
authored
Merge pull request #82 from WorkflowAI/add-api-key-setup-docs
docs: add API key setup instructions to README
2 parents 80761fb + ad7b21a commit 99c3e9f

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,18 @@ This SDK is designed for Python teams who prefer code-first development. It prov
4848
pip install workflowai
4949
```
5050

51+
### API Key
52+
53+
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.
54+
55+
Then, set the `WORKFLOWAI_API_KEY` environment variable:
56+
57+
```sh
58+
export WORKFLOWAI_API_KEY="your-api-key"
59+
```
60+
61+
### First Agent
62+
5163
Here's a simple example of a WorkflowAI agent that extracts structured flight information from email content:
5264

5365

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

168180
See the [CONTRIBUTING.md](./CONTRIBUTING.md) file for more details. Thank you!
181+
182+
## Acknowledgments
183+
184+
Thanks to [ell](https://github.com/MadcowD/ell) for the inspiration! ✨

0 commit comments

Comments
 (0)