Skip to main content

Basics

This section covers the fundamental information you need to start making requests to the WiseOCR API.

Create API Key 🔑​

1. Visit the API Keys Page​

API Keys menu navigation

Head over to Dashboard/API Keys in your Dashboard to get started.

2. Enter a Name and Generate Your Key​

API Key generation form

  • Give your API key a descriptive name to easily identify it later
  • Click the "Generate API Key" button to create a new key

3. Save Your Key Securely ⚠️​

Generated API Key display

Copy and store your API key in a secure location.

warning

You'll only see this key once. If you lose it, you'll need to generate a new one.

4. Ready to Use ✨​

Your API key is now active and ready for integration with our services.

tip

You can deactivate or delete your API key at any time from the API keys dashboard.

Security Best Practices​

  • Never share your API key in public repositories or client-side code
  • Consider using environment variables to store your API key in applications
  • Rotate your keys periodically for enhanced security
  • Use separate keys for development and production environments

API Base URL​

Production URL: https://api.wiseocr.com/v1/file

This serves as the base URL for all API endpoints. Append specific endpoint paths to this URL to access different API functionalities.

Authentication​

API Key Authentication​

All API requests must include an API key in the Authorization header:

Authorization: your-api-key

Example Request with Authentication​

curl -X POST https://api.wiseocr.com/v1/file \
  -H "Authorization: YOUR_API_KEY" \
  -H "Content-Type: multipart/form-data" \
  -F "file=@receipt.jpg"

Rate Limiting​

The API implements rate limiting to ensure fair usage. Current limits are:

  • 100 requests per minute
  • 1,000 requests per day

If you exceed these limits, you'll receive a 429 Too Many Requests response.

Response Formats​

All API responses are returned in JSON format with appropriate HTTP status codes:

{
  "data": {
    "field1": "value1",
    "field2": "value2"
  }
}

Error responses follow this structure:

{
  "error": "Error message"
}

Versioning​

The current API version is v1. The version is included in the base URL to ensure compatibility as we evolve our services.

Support​

If you encounter any issues or have questions about the API, please contact our support team at support@wiseocr.com

What's next?​