Getting Started
Configuration
API base URL, authentication, rate limits, and managing your account.
API base URL
All API requests go to:
https://provenance.onrender.com/apiAuthentication
Every request requires your API key in the x-api-key header:
curl -H "x-api-key: your-api-key" https://provenance.onrender.com/api/actionsManaging API keys
You receive your first API key at signup. From the platform dashboard, you can:
- Create additional keys with labels (e.g., "Production", "CI/CD", "Development")
- Revoke keys that are no longer needed
- View key prefixes to identify which key is which
API keys are shown once at creation — store them securely.
CLI configuration
provenance config set apiUrl https://provenance.onrender.com/api
provenance config set apiKey your-api-key
provenance config set origin MY-SERVICEOr use environment variables (recommended for CI/CD):
export PROVENANCE_API_URL=https://provenance.onrender.com/api
export PROVENANCE_API_KEY=your-api-key
export PROVENANCE_ORIGIN=MY-SERVICESDK configuration
const { create } = require('@stdiolabs/provenance-sdk');
const provenance = await create({
apiKey: 'your-api-key',
origin: 'my-service',
});
// Queue-based ingestion
await provenance.log({ resourceType: 'user', resourceId: 'user-123', action: 'create', ... });
// REST API client
const api = await provenance.api();All SDKs resolve queue credentials and API URL automatically from the platform. A C# SDK is coming soon — see SDKs.
Rate limits
| Endpoint category | Limit | Window |
|---|---|---|
| General API | 100 requests | 15 minutes |
| Sensitive operations (create/update/delete) | 20 requests | 15 minutes |
| Queue processing | 10 requests | 1 minute |
Rate limit headers are included in every response:
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 97
X-RateLimit-Reset: 1705312800Plan limits
Each plan has usage limits that are enforced at the API level:
| Resource | Free | Pro | Business |
|---|---|---|---|
| Interactions/month | 10,000 | 100,000 | 1,000,000 |
| Data retention | 30 days | 1 year | 2 years |
| Dashboards | 1 | Unlimited | Unlimited |
| Widgets per dashboard | 3 | Unlimited | Unlimited |
| Alerts | 3 | Unlimited | Unlimited |
| Subscriptions | 3 | Unlimited | Unlimited |
| Team members | 1 | 5 | Unlimited |
| API keys | 2 | 10 | Unlimited |
Check your current usage from the platform dashboard or via the API:
GET https://provenance.onrender.com/platform/usageTeam members
Invite team members from the platform dashboard. Each member gets a role:
| Role | Permissions |
|---|---|
| Owner | Full access, billing, delete organization |
| Admin | Manage API keys, members, configuration |
| Member | Create interactions, view data |
| Viewer | Read-only access |
Interactive API docs
Swagger documentation is available at:
https://provenance.onrender.com/api-docs