Headers

Headers you send

Header	Required	Purpose
X-API-Key	Yes	Your API key. The gateway removes it before forwarding, so providers never see it.
Content-Type	For requests with a body	For example application/json or multipart/form-data.

Any other headers you send (for example Accept) are passed to the provider unchanged.

Headers you receive

In addition to the provider's own response headers:

Header	Meaning
X-Request-Id	A unique ID for this call. Quote it when asking for help.
X-RateLimit-Quota-Limit	Your plan's requests per billing month.
X-RateLimit-Quota-Remaining	Requests left this month.
X-RateLimit-Quota-Reset	Seconds until the quota resets.
X-RateLimit-Requests-Limit	Requests allowed per rate-limit window (plans with a rate limit only).
X-RateLimit-Requests-Remaining	Requests left in the current window.
X-RateLimit-Requests-Reset	Seconds until the window resets.

Headers providers receive

Providers get these extra headers on every forwarded request, so they can identify the caller without handling keys. See Gateway and security.

Header	Value
X-APIHiver-Request-Id	The same ID the consumer sees as X-Request-Id
X-APIHiver-Consumer-Id	The consumer's user ID
X-APIHiver-Consumer-Username	The consumer's username
X-APIHiver-Subscription-Id	The subscription being billed
X-APIHiver-Plan	The consumer's plan name
secret header	The provider's own secret, configured in Gateway