Skip to main content

Authentication

All Classify API requests are authenticated using an API key passed in a request header.

Getting an API key​

API keys are provisioned by Classify. If you don't have one yet, contact your Classify representative or email sales@tryclassify.com.

Making authenticated requests​

Include your API key in every request using the X-API-Key header:

X-API-Key: <your_api_key>

All request bodies should use JSON with the appropriate content type header:

Content-Type: application/json

Base URL​

https://api.clsfy.me/v1

All API endpoints are relative to this base URL.

Example​

curl -X POST "https://api.clsfy.me/v1/scraping/search" \
  -H "X-API-Key: <your_api_key>" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com/some-article"}'

Security​

  • Keep your API key private — treat it like a password
  • Do not include it in client-side code or commit it to source control
  • If you believe your key has been compromised, contact Classify immediately to have it rotated