- X-Jojapi-Gateway-Response: Always has the value
true. Its presence indicates that the response body was generated by the gateway rather than the upstream API — see Gateway Generated Responses for details. - X-Jojapi-Request-Latency: Specifies the completion time for the current request on the gateway. The duration of the request measured by the consumer may be longer.
- X-Jojapi-User-Balance: Specifies the remaining user balance after the current request has been processed. Sent on pay-as-you-go plans only.
- PAYMENT-RESPONSE / Payment-Receipt: On requests paid per call by an agent wallet, the settlement proof — a base64 x402
SettlementResponse(transaction, network, payer) or an MPP receipt. See Agent payments.
Per-object usage headers
Usage is reported per billable object, keyed by the object’s slug:- X-Jojapi-<slug>-Used: The amount of this object consumed by the current request — e.g.
X-Jojapi-Credits-Used, orX-Jojapi-Ai-Tokens-Usedfor an object with the slugai-tokens. - X-Jojapi-<slug>-Remaining: The remaining included quota for this object after the current request. Applies to fixed-price plans.
- X-Jojapi-<slug>-Total-Used: The total amount of this object consumed within the current period after this request. Applies to pay-as-you-go plans only.
credits, so the long-standing X-Jojapi-Credits-Used, X-Jojapi-Credits-Remaining and X-Jojapi-Credits-Total-Used headers are unchanged — they are simply the Credits instance of the per-object scheme.
Deprecated endpoints
When a provider deprecates an endpoint, it keeps working as before, and every response the gateway returns for it carries these standard headers. Gateway refusals of that endpoint carry them too (for example a429).
- Deprecation (RFC 9745): the date of the deprecation as a Unix timestamp, e.g.
Deprecation: @1793491200. A date in the future announces it. - Sunset (RFC 8594): the removal date the provider announced, e.g.
Sunset: Mon, 01 Feb 2027 00:00:00 GMT. Only when one is set. - Link: the endpoint’s documentation with
rel="deprecation", and the endpoint to use instead withrel="successor-version"when there is one. ALinkheader the API itself sends stays.
Keys that hide these headers
Responses to an API key with Hide JoJ API headers turned on carry none of theX-Jojapi-* headers on this page — for keys a bridge or reseller calls APIs with. Usage and billing are unchanged. Deprecated endpoints still send Deprecation and Sunset to these keys, but no Link, since it points to the JoJ API page. See Hiding JoJ API headers.