Documentation Index
Fetch the complete documentation index at: https://docs.trymaven.com/llms.txt
Use this file to discover all available pages before exploring further.
All Maven API requests are authenticated with API keys passed as Bearer tokens.
| Component | Description |
|---|
mvn | Fixed prefix |
mode | test or live — determines which gateway credentials are used |
secret | 32-character random string |
Examples:
- Test:
mvn_test_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6
- Live:
mvn_live_q7r8s9t0u1v2w3x4y5z6a7b8c9d0e1f2
Usage
Pass your API key as a Bearer token in the Authorization header:
curl -X GET https://api.trymaven.com/v1/auth/check \
-H "Authorization: Bearer mvn_test_your_key_here"
Test vs Live Mode
| Feature | Test (mvn_test_) | Live (mvn_live_) |
|---|
| Gateway credentials | Test/sandbox | Production |
| Real charges | No | Yes |
| Card validation | Full | Full |
| Voice calls | Real calls placed | Real calls placed |
| Rate limits | Same as live | 20 req/min per endpoint |
Test mode places real calls. Use your own phone number as the caller during testing.
Key Management
Manage API keys in the Maven Dashboard under Settings > API Keys.
Create a key
Click Create Key and select the mode (test or live).
Copy the key
Copy the full key immediately — it will only be shown once.
Store securely
The key is hashed server-side (SHA-256). If you lose it, revoke and create a new one.
Error Responses
| Status Code | Meaning |
|---|
401 | Invalid API key, expired key, or missing Authorization header |
403 | Key is valid but lacks required scopes |
429 | Rate limit exceeded |