Skip to main content
You will hit GET /v1/health to verify your key works, then look up a real conversation.

​
1. Get an API key

Authorized admin users can create a key in the ProVision portal:
  1. Open Settings → Integrations → Developer.
  2. Click Create key (or Create your first key if the list is empty).
  3. Enter a name for the key and select the operation scopes your integration needs.
  4. Click Create key, then copy the full key from the one-time reveal dialog and store it in your secret manager.
The full key value is shown only once. If you lose it, regenerate the key from the Developer tab. If you do not see the Developer tab, ask a ProVision admin on your team to grant access or create a key for you.

​
2. Confirm the key works

Expected response:
If you get 401 or 403, check the error.code in the response body — a brand-new key can return 403 INVALID_API_KEY for a few minutes while it activates. See Authentication errors. If you get 429, your key is being throttled — see Rate limits.

​
3. Read a conversation

Expected: a JSON document matching the schema described under API Reference → conversation → getConversation. The ?include= query parameter expands related resources; see the API Reference for the supported values.

​
4. Next steps

  • Browse the full API Reference tab.
  • Read Permissions to understand which operations your key can call.
  • Need help choosing scopes or troubleshooting access? Email help@onevisionresources.com.