Sandbox / Beta

ProvenTen API Quick Start

This walkthrough takes you from a ProvenTen Platform account to a verified API response. Public traffic is not open yet, so you will finish against a simulated sandbox on this page. The steps and payloads match the contract in the API Reference.

Estimated time: 5 mins
Prerequisites: ProvenTen Platform account
Status: Sandbox / Beta

1
Obtain API credentials
Sign in to the ProvenTen Platform and open Settings → API Keys. Create a key for the environment you are targeting, then store it as an environment variable. Do not commit keys or paste them into client-side apps.
- pt_test_... — Sandbox. Use this while you integrate.
- pt_live_... — Production. Only after your integration is reviewed.
During private beta, keys are issued after we review a request. If you do not see API Keys in Settings yet, request beta access.
2
Install an SDK or use an HTTP client
Official packages are not on public registries yet. These are the install names we will publish. Until then, any HTTP client works — cURL needs nothing installed.
Install
```
npm install @proventen/sdk
```
```
pip install proventen
```
```
# No installation required.
# Call the API with any HTTP client.
```

Authenticate your requests

Every request needs a Bearer token. SDKs take apiKey in the client initializer and attach the header for you. With cURL or fetch, set it yourself:

Authorization: Bearer <API_KEY>

Client setup

# Pass the key on every request.
curl https://api.proventen.com/v1/system/status \
  -H "Authorization: Bearer $PROVENTEN_API_KEY"

import { ProvenTen } from '@proventen/sdk';

const client = new ProvenTen({
  apiKey: process.env.PROVENTEN_API_KEY,
});

// HTTP clients use the same header:
// Authorization: Bearer <API_KEY>

import os
from proventen import Client

client = Client(api_key=os.environ["PROVENTEN_API_KEY"])

# HTTP clients use the same header:
# Authorization: Bearer <API_KEY>

Make your first API call

Start with GET /v1/system/status. It confirms the key, the environment, and that you can reach the API. Creating workflows (/v1/workflows) will follow in a later sandbox build.

GET /v1/system/status

curl https://api.proventen.com/v1/system/status \
  -H "Authorization: Bearer YOUR_API_KEY"

const res = await fetch('https://api.proventen.com/v1/system/status', {
  headers: {
    Authorization: `Bearer ${process.env.PROVENTEN_API_KEY}`,
  },
});

const status = await res.json();
console.log(status.environment, status.ok);

import os
import requests

res = requests.get(
    "https://api.proventen.com/v1/system/status",
    headers={"Authorization": f"Bearer {os.environ['PROVENTEN_API_KEY']}"},
)
print(res.json())

5
Verify the response
A healthy sandbox call returns 200 OK and a JSON body like this:
```
{
  "ok": true,
  "environment": "sandbox",
  "version": "v1.0",
  "checked_at": "2026-08-16T10:04:12Z"
}
```
Optional — webhook listener. When you subscribe to events, ProvenTen POSTs signed JSON to your HTTPS endpoint. A completed workflow looks like this:
```
{
  "id": "evt_3c91d2",
  "type": "workflow.completed",
  "created_at": "2026-08-16T10:06:18Z",
  "data": {
    "workflow_id": "wf_9a14",
    "status": "completed"
  }
}
```
See webhook setup in the API Reference for POST /v1/events/subscribe and signature checks.

Try in sandbox

Public API traffic is not open yet. Run a simulated GET /v1/system/status here to see the response shape without a live key.

Ready · GET /v1/system/status

Click “Run Sample Request” to see a simulated 200 OK payload.

Next steps

When you are ready to go further, these are the three useful doors.

Look it up

ProvenTen API Quick Start

Obtain API credentials

Install an SDK or use an HTTP client

Authenticate your requests

Make your first API call

Verify the response

Try in sandbox

Next steps

API Reference

Webhook setup

Request beta access