Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.prudra.dev/llms.txt

Use this file to discover all available pages before exploring further.

Authenticate your requests

Every request to the Prudra API must include an API key. API keys are scoped to an organisation and grant full access to all resources in that organisation.

API key formats

Prudra uses two key formats depending on your environment:
FormatEnvironmentUse when
prv_test_sk_...Test / developmentLocal development, CI, staging environments
prv_live_sk_...Live / productionProduction servers making real payments
Test keys make real API calls but payments are processed in stub mode by default — no real crypto moves. Live keys process real payments on mainnet.
Never use a live key in development or commit any key to version control. Use environment variables to keep keys out of your code.

Get an API key

  1. Go to dashboard.prudra.com and sign in
  2. Click Settings in the left sidebar
  3. Click API Keys
  4. Click Create API key
  5. Enter a name for the key (e.g. “Development” or “Production server”)
  6. Click Create
The raw key is shown once. Copy it immediately — it cannot be retrieved again.Store the key in your environment:
PRUDRA_API_KEY=prv_test_sk_your_key_here

Pass the key in requests

All API requests use Bearer token authentication in the Authorization header:
Authorization: Bearer prv_test_sk_your_key_here
When using the SDK, initialise() handles this automatically for all SDK calls. When making direct API calls:
curl https://api.prudra.dev/billing/usage \
  -H "Authorization: Bearer prv_test_sk_your_key_here"

Error responses

A missing or invalid key returns HTTP 401:
{
  "type": "https://api.prudra.dev/problems/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Invalid or missing API key."
}
CauseResolution
Key missing from headerAdd Authorization: Bearer prv_test_sk_... to the request
Key format wrongKeys start with prv_test_sk_ or prv_live_sk_ — check for typos
Key revokedCreate a new key in the dashboard. Revoked keys cannot be reactivated.
Wrong environmentTest keys don’t work against live endpoints and vice versa
Key belongs to different orgEach key is org-scoped — use the correct key for your organisation

List and revoke keys

Go to Settings → API Keys in dashboard.prudra.com. All active keys for your organisation are listed (raw key values are never shown). Click Revoke next to any key to immediately invalidate it.

Best practices

  • Use one key per service — if a key is compromised, you can revoke it without affecting other services
  • Store keys in environment variables, never in code or config files
  • Use test keys (prv_test_sk_) in development and CI
  • Rotate live keys periodically or immediately if compromised
  • The apiKeyId field on payment logs lets you trace which key was used for each payment