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

Email support@onevisionresources.com with the partner you represent. Support will reply with a UAT key first; production keys are issued after you have completed at least one successful UAT round-trip.

​
2. Confirm the key works

curl -sS https://connect.uat.provisionapp.xyz/v1/health \
  -H "x-api-key: $PROVISION_API_KEY"
Expected response: 
{ "status": "ok" }
If you get 403, the key is wrong or has not been activated yet. If you get 429, your key is being throttled — see Rate limits.

​
3. Read a conversation

curl -sS "https://connect.uat.provisionapp.xyz/v1/conversation/$CONVERSATION_ID" \
  -H "x-api-key: $PROVISION_API_KEY"
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.
  • Build a deeper integration; reach out to support@onevisionresources.com when you are ready for a production key.