Omni Text

Authentication

Learn how to authenticate API requests using Bearer tokens

Authentication

All API requests require authentication using an API key in the x-api-key header.

Basic Usage

Include your API key in the x-api-key header:

x-api-key: YOUR_API_KEY

Getting Your API Key

To obtain an API key, follow the steps in the Quick Start guide.

Example Request

curl -X POST 'https://api.omnitext.io/v1/extract/markdown' \
  -H 'x-api-key: YOUR_API_KEY' \
  -F 'file=@document.pdf'

Security Best Practices

  • Store API keys securely and never expose them in client-side code
  • Use environment variables for API keys in production
  • Rotate keys regularly for enhanced security

Troubleshooting

For authentication-related errors and troubleshooting, refer to the API Reference error response documentation.