Authentication

Getting Your API Key

1. 1Sign up or log in at the Dashboard.
2. 2Click + New Key and give it a descriptive name (e.g., “Production”, “Staging”).
3. 3Copy the key immediately. It is shown only once and cannot be retrieved later.

You can also create API keys programmatically via the POST /api/auth/register endpoint.

Using Your API Key

Include your key in every request using one of these methods:

Method 1: X-API-Key Header (Recommended)

curl -X POST https://parseflow.dev/api/v1/extract \
  -H "X-API-Key: dm_live_your_api_key_here" \
  -F "file=@invoice.pdf"

Method 2: Authorization Bearer

curl -X POST https://parseflow.dev/api/v1/extract \
  -H "Authorization: Bearer dm_live_your_api_key_here" \
  -F "file=@invoice.pdf"

Python Example

import requests

response = requests.post(
    "https://parseflow.dev/api/v1/extract",
    headers={"X-API-Key": "dm_live_your_api_key_here"},
    files={"file": open("invoice.pdf", "rb")},
    data={"document_type": "invoice"}
)

print(response.json())

Node.js Example

const FormData = require('form-data');
const fs = require('fs');
const axios = require('axios');

const form = new FormData();
form.append('file', fs.createReadStream('invoice.pdf'));
form.append('document_type', 'invoice');

const response = await axios.post(
  'https://parseflow.dev/api/v1/extract',
  form,
  {
    headers: {
      'X-API-Key': 'dm_live_your_api_key_here',
      ...form.getHeaders()
    }
  }
);

console.log(response.data);

Go Example

req, _ := http.NewRequest("POST",
    "https://parseflow.dev/api/v1/extract", body)
req.Header.Set("X-API-Key", "dm_live_your_api_key_here")
req.Header.Set("Content-Type", writer.FormDataContentType())

resp, _ := http.DefaultClient.Do(req)

Key Formats

All ParseFlow API keys follow a consistent format:

Keys are 56 characters long: 8-character prefix + 48 random hex characters.

Security Best Practices

• Never expose keys in client-side code. Always call the API from your backend.
• Use environment variables to store keys. Never commit them to version control.
• Use separate keys for different environments (production, staging, development).
• Revoke compromised keys immediately from the dashboard.
• Rotate keys periodically — we recommend every 90 days.

Key Rotation

To rotate a key without downtime:

1. Create a new API key from the dashboard
2. Update your application to use the new key
3. Deploy the change and verify it works
4. Revoke the old key from the dashboard

Both keys will work simultaneously during the transition, so there is no downtime.

Rate Limits by Plan