Skip to main content

​
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

from pulse import Pulse

# Initialize the client with your API key
client = Pulse(api_key="YOUR_API_KEY")

# Extract a document
response = client.extract(
    file_url="https://www.impact-bank.com/user/file/dummy_statement.pdf"
)

print(f"Job ID: {response.job_id}")

​
Install the SDKs

pip install pulse-python-sdk

​
API Key Security

  • Never expose API keys in client-side code - Use server-side proxies
  • Use environment variables - Don’t hardcode keys in your source code
  • Rotate keys regularly - Generate new keys periodically
  • Use separate keys - Different keys for development, staging, and production
Store your API key in environment variables:
.env
PULSE_API_KEY=your_api_key_here

import os
from pulse import Pulse

client = Pulse(api_key=os.getenv("PULSE_API_KEY"))
To rotate your API key:
  1. Generate a new key in the Console
  2. Update your application to use the new key
  3. Verify the new key is working
  4. Delete the old key from the Console

​
Managing API Keys

​
View Active Keys

Access your API keys at the Console:
  • 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

Solution: Ensure you’re providing your API key when initializing the client
from pulse import Pulse

client = Pulse(api_key="YOUR_API_KEY")
Possible causes:
  • Key was typed incorrectly
  • Key has been deleted
  • Using a key from a different environment
Solution: Verify your key in the Console and ensure you’re copying it correctly
Solution:
  • Check your usage in the Console
  • Upgrade your plan for higher limits
  • Contact support for temporary limit increases

​
Next Steps

Quickstart Guide

Start making your first API calls

API Reference

Explore available endpoints