​
Overview

All Pulse API endpoints require authentication using an API key. This key identifies your organization and tracks usage for billing purposes.

​
Getting Your API Key

1

Sign Up

Create an account at console.runpulse.com
2

Generate API Key

Navigate to the API Keys section in your dashboard
3

Copy Your Key

Click “Create New Key” and copy the generated key immediately
API keys are shown only once when created. Store them securely - you cannot retrieve them later.

​
Using Your API Key

Include your API key in the x-api-key header with every request: 
curl -X POST https://dev.api.runpulse.com/extract \
  -H "x-api-key: YOUR_API_KEY" \
  -F "file=@document.pdf"

​
API Key Security

​
Managing API Keys

​
View Active Keys

Access your API keys at console.runpulse.com:
  • See all active keys
  • View creation dates
  • Monitor usage per key
  • Delete compromised keys

​
Key Permissions

All API keys have full access to:
  • Document extraction endpoints
  • File upload endpoints
  • Job management endpoints
  • Webhook configuration
Fine-grained permissions are coming soon. Contact support if you need restricted access patterns.

​
Troubleshooting

​
Common Authentication Errors

​
Next Steps

Quickstart Guide

Start making your first API calls

API Reference

Explore available endpoints