From 373900eb887b2ab0ba35f96821e91e89849a685d Mon Sep 17 00:00:00 2001 From: rimkusaurimas Date: Wed, 6 May 2026 15:03:37 +0200 Subject: [PATCH] docs(readme): add onboarding steps for PROVABLY_API_KEY + PROVABLY_ORG_ID MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit New 'Getting PROVABLY_API_KEY and PROVABLY_ORG_ID' subsection under Configuration: 1. Sign up at app.provably.ai 2. Create an organisation (org id shown in the URL) 3. Left-side menu → Integrations → create one (generated key) Plus a pointer to provably.ai/docs for full product documentation. Closes the gap surfaced while users were trying to find where these values come from — the env-var table told them they were required but not where to source them. --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 389c962..8817353 100644 --- a/README.md +++ b/README.md @@ -160,6 +160,14 @@ The SDK reads configuration from environment variables. A typed `Provably(api_key=..., org_id=..., ...)` client that replaces these globals is planned (issue [#2](https://github.com/ProvablyAI/provably-python-sdk/issues/2)). +#### Getting `PROVABLY_API_KEY` and `PROVABLY_ORG_ID` + +1. Sign up at [app.provably.ai](https://app.provably.ai). +2. Create an organisation. The org id is shown in the URL after creation and is what goes in `PROVABLY_ORG_ID`. +3. In the left-side menu, go to **Integrations** and create one. The generated key is your `PROVABLY_API_KEY`. + +Full product docs: [provably.ai/docs](https://provably.ai/docs). + | Variable | Used by | Required | |---|---|---| | `PROVABLY_API_KEY` | `initialize_runtime`, integration cache | yes |