Skip to Content

GatewayHeaders

const GatewayHeaders: object;

The response headers a gateway caller reads.

Type Declaration

outputTokenCap

readonly outputTokenCap: "x-modem-output-token-cap" = 'x-modem-output-token-cap';

The output-token cap the gateway wrote into the request, when it wrote one.

rateLimit

readonly rateLimit: object;

The most restrictive rate limit that applies, per metric, in OpenAI’s header names.

rateLimit.limitRequests

readonly limitRequests: "x-ratelimit-limit-requests" = 'x-ratelimit-limit-requests';

rateLimit.limitTokens

readonly limitTokens: "x-ratelimit-limit-tokens" = 'x-ratelimit-limit-tokens';

rateLimit.remainingRequests

readonly remainingRequests: "x-ratelimit-remaining-requests" = 'x-ratelimit-remaining-requests';

rateLimit.remainingTokens

readonly remainingTokens: "x-ratelimit-remaining-tokens" = 'x-ratelimit-remaining-tokens';

rateLimit.resetRequests

readonly resetRequests: "x-ratelimit-reset-requests" = 'x-ratelimit-reset-requests';

rateLimit.resetTokens

readonly resetTokens: "x-ratelimit-reset-tokens" = 'x-ratelimit-reset-tokens';

requestId

readonly requestId: "x-request-id" = 'x-request-id';

retryAfter

readonly retryAfter: "retry-after" = 'retry-after';

shouldRetry

readonly shouldRetry: "x-should-retry" = 'x-should-retry';

false on a rejection that retrying cannot fix. The OpenAI and Anthropic SDKs obey it.

Last updated on