Authentication
All API requests to Parsify require authentication via an API key. API keys are scoped to your organization and can be configured with granular permissions.
Getting an API Key
- Log in to the Parsify Dashboard
- Navigate to Settings → API Keys
- Click Create API Key
- Select the scopes your key needs (see below)
- Copy the key — it will only be shown once
Using Your API Key
Include your API key in the X-API-Key header with every request:
curl https://api.parsifyhq.com/api/v1/documents/ \
-H "X-API-Key: YOUR_API_KEY"Scopes
API keys can be created with specific scopes to limit access. When creating a key, select only the scopes required for your use case.
| Scope | Description |
|---|---|
documents:read | Read documents |
documents:write | Upload documents |
jobs:read | Read extraction jobs |
jobs:write | Create and resubmit extraction jobs |
migrations:read | Read migrations, runs, and validations |
migrations:write | Create and update migrations, runs, and validations |
validations:read | Read validation reports |
validations:write | Create validation reports |
providers:read | Read provider information |
Error Responses
If authentication fails, the API returns a 401 Unauthorized response:
{
"detail": "Authentication credentials were not provided."
}If your API key lacks the required scope for an endpoint, you will receive a 403 Forbidden response:
{
"detail": "You do not have permission to perform this action."
}Best Practices
- Least privilege — Create keys with only the scopes you need.
- Rotate regularly — Delete and recreate keys periodically.
- Never expose keys in client-side code — API keys should only be used in server-side applications.
- Use separate keys for different environments (development, staging, production).