Skip to main content

Authentication

The Parselyze API uses API key authentication for document processing.

API Key Authentication

API keys authenticate requests to the document analysis endpoint.

Request Header

Include your API key in the request header:

x-api-key: your_api_key_here

Getting Your API Key

  1. Log in to your Parselyze dashboard
  2. Navigate to "Account" > "API Keys"
  3. Provide a description for the key
  4. Click "Generate Key"
  5. Copy and securely store the generated key
API Key Generation

Security Note: API keys are only displayed once during creation.

Available Endpoints

Only one endpoint supports API key authentication:

  • POST /documents/parse - Process documents with OCR

All other features (templates, account management) require web interface access.

Best Practices

  • Create separate keys for different environments (dev, staging, prod)
  • Rotate keys regularly for security
  • Never commit keys to source code - use environment variables
  • Store keys securely

Error Codes

CodeDescriptionSolution
401Missing or invalid API keyCheck that x-api-key header is included with valid key
403Insufficient permissionsVerify your subscription plan supports the requested feature
429Rate limit exceededWait before retrying or upgrade your plan

Base URL

https://api.parselyze.com