Skip to main content

API Key Authentication

All API requests (except the health check endpoint) require authentication via an API key.

Getting an API Key

API keys are issued through your GreetIncs dashboard. Keys follow the format:
greetincs_...

Using Your API Key

Include your API key in the X-API-Key header with every request:
curl -X GET "https://api.greetincs.com/v1/analyses/" \
  -H "X-API-Key: greetincs_your_api_key"

Security Best Practices

Never expose your API key in client-side code, public repositories, or logs.
  • Store API keys in environment variables or secrets managers
  • Use different keys for development and production
  • Rotate keys periodically
  • Revoke compromised keys immediately

Error Responses

StatusMeaning
401Missing or invalid API key
402Payment required - check your account status
403API key valid but lacks permission for this resource