@ai-sdk/gateway 4.0.0-beta.23 → 4.0.0-beta.24

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @ai-sdk/gateway
 
+## 4.0.0-beta.24
+
+### Patch Changes
+
+- d30466c: feat (provider/gateway): add spend reporting support
+
 ## 4.0.0-beta.23
 
 ### Patch Changes

package/dist/index.d.mts

@@ -64,6 +64,62 @@ interface GatewayCreditsResponse {
     totalUsed: string;
 }
 
+interface GatewaySpendReportParams {
+    /** Start date in YYYY-MM-DD format (inclusive) */
+    startDate: string;
+    /** End date in YYYY-MM-DD format (inclusive) */
+    endDate: string;
+    /** Primary aggregation dimension. Defaults to 'day'. */
+    groupBy?: 'day' | 'user' | 'model' | 'tag' | 'provider' | 'credential_type';
+    /** Time granularity when groupBy is 'day'. */
+    datePart?: 'day' | 'hour';
+    /** Filter to a specific user's spend. */
+    userId?: string;
+    /** Filter to a specific model (e.g. 'anthropic/claude-sonnet-4.5'). */
+    model?: string;
+    /** Filter to a specific provider (e.g. 'anthropic'). */
+    provider?: string;
+    /** Filter to BYOK or system credentials. */
+    credentialType?: 'byok' | 'system';
+    /** Filter to requests with these tags. */
+    tags?: string[];
+}
+interface GatewaySpendReportRow {
+    /** Date string (present when groupBy is 'day') */
+    day?: string;
+    /** Hour timestamp (present when groupBy is 'day' and datePart is 'hour') */
+    hour?: string;
+    /** User identifier (present when groupBy is 'user') */
+    user?: string;
+    /** Model identifier (present when groupBy is 'model') */
+    model?: string;
+    /** Tag value (present when groupBy is 'tag') */
+    tag?: string;
+    /** Provider name (present when groupBy is 'provider') */
+    provider?: string;
+    /** Credential type (present when groupBy is 'credential_type') */
+    credentialType?: 'byok' | 'system';
+    /** Total cost in USD */
+    totalCost: number;
+    /** Market cost in USD */
+    marketCost?: number;
+    /** Number of input tokens */
+    inputTokens?: number;
+    /** Number of output tokens */
+    outputTokens?: number;
+    /** Number of cached input tokens */
+    cachedInputTokens?: number;
+    /** Number of cache creation input tokens */
+    cacheCreationInputTokens?: number;
+    /** Number of reasoning tokens */
+    reasoningTokens?: number;
+    /** Number of requests */
+    requestCount?: number;
+}
+interface GatewaySpendReportResponse {
+    results: GatewaySpendReportRow[];
+}
+
 type GatewayEmbeddingModelId = 'alibaba/qwen3-embedding-0.6b' | 'alibaba/qwen3-embedding-4b' | 'alibaba/qwen3-embedding-8b' | 'amazon/titan-embed-text-v2' | 'cohere/embed-v4.0' | 'google/gemini-embedding-001' | 'google/gemini-embedding-2' | 'google/text-embedding-005' | 'google/text-multilingual-embedding-002' | 'mistral/codestral-embed' | 'mistral/mistral-embed' | 'openai/text-embedding-3-large' | 'openai/text-embedding-3-small' | 'openai/text-embedding-ada-002' | 'voyage/voyage-3-large' | 'voyage/voyage-3.5' | 'voyage/voyage-3.5-lite' | 'voyage/voyage-4' | 'voyage/voyage-4-large' | 'voyage/voyage-4-lite' | 'voyage/voyage-code-2' | 'voyage/voyage-code-3' | 'voyage/voyage-finance-2' | 'voyage/voyage-law-2' | (string & {});
 
 type GatewayImageModelId = 'bfl/flux-2-flex' | 'bfl/flux-2-klein-4b' | 'bfl/flux-2-klein-9b' | 'bfl/flux-2-max' | 'bfl/flux-2-pro' | 'bfl/flux-kontext-max' | 'bfl/flux-kontext-pro' | 'bfl/flux-pro-1.0-fill' | 'bfl/flux-pro-1.1' | 'bfl/flux-pro-1.1-ultra' | 'google/imagen-4.0-fast-generate-001' | 'google/imagen-4.0-generate-001' | 'google/imagen-4.0-ultra-generate-001' | 'openai/gpt-image-1' | 'openai/gpt-image-1-mini' | 'openai/gpt-image-1.5' | 'prodia/flux-fast-schnell' | 'recraft/recraft-v2' | 'recraft/recraft-v3' | 'recraft/recraft-v4' | 'recraft/recraft-v4-pro' | 'xai/grok-imagine-image' | 'xai/grok-imagine-image-pro' | (string & {});
@@ -370,6 +426,11 @@ interface GatewayProvider extends ProviderV4 {
      * Returns credit information for the authenticated user.
      */
     getCredits(): Promise<GatewayCreditsResponse>;
+    /**
+     * Returns a spend report with cost, token, and request count data,
+     * aggregated by the specified dimension.
+     */
+    getSpendReport(params: GatewaySpendReportParams): Promise<GatewaySpendReportResponse>;
     /**
      * Creates a model for generating text embeddings.
      */
@@ -599,4 +660,4 @@ declare class GatewayResponseError extends GatewayError {
     static isInstance(error: unknown): error is GatewayResponseError;
 }
 
-export { GatewayAuthenticationError, type GatewayCreditsResponse, GatewayError, type GatewayErrorResponse, GatewayInternalServerError, GatewayInvalidRequestError, type GatewayLanguageModelEntry, type GatewayProviderOptions as GatewayLanguageModelOptions, type GatewayLanguageModelSpecification, type GatewayLanguageModelEntry as GatewayModelEntry, type GatewayModelId, GatewayModelNotFoundError, type GatewayProvider, type GatewayProviderOptions, type GatewayProviderSettings, GatewayRateLimitError, GatewayResponseError, type GatewayVideoModelId, createGatewayProvider as createGateway, createGatewayProvider, gateway };
+export { GatewayAuthenticationError, type GatewayCreditsResponse, GatewayError, type GatewayErrorResponse, GatewayInternalServerError, GatewayInvalidRequestError, type GatewayLanguageModelEntry, type GatewayProviderOptions as GatewayLanguageModelOptions, type GatewayLanguageModelSpecification, type GatewayLanguageModelEntry as GatewayModelEntry, type GatewayModelId, GatewayModelNotFoundError, type GatewayProvider, type GatewayProviderOptions, type GatewayProviderSettings, GatewayRateLimitError, GatewayResponseError, type GatewaySpendReportParams, type GatewaySpendReportResponse, type GatewaySpendReportRow, type GatewayVideoModelId, createGatewayProvider as createGateway, createGatewayProvider, gateway };

package/dist/index.d.ts

@@ -64,6 +64,62 @@ interface GatewayCreditsResponse {
     totalUsed: string;
 }
 
+interface GatewaySpendReportParams {
+    /** Start date in YYYY-MM-DD format (inclusive) */
+    startDate: string;
+    /** End date in YYYY-MM-DD format (inclusive) */
+    endDate: string;
+    /** Primary aggregation dimension. Defaults to 'day'. */
+    groupBy?: 'day' | 'user' | 'model' | 'tag' | 'provider' | 'credential_type';
+    /** Time granularity when groupBy is 'day'. */
+    datePart?: 'day' | 'hour';
+    /** Filter to a specific user's spend. */
+    userId?: string;
+    /** Filter to a specific model (e.g. 'anthropic/claude-sonnet-4.5'). */
+    model?: string;
+    /** Filter to a specific provider (e.g. 'anthropic'). */
+    provider?: string;
+    /** Filter to BYOK or system credentials. */
+    credentialType?: 'byok' | 'system';
+    /** Filter to requests with these tags. */
+    tags?: string[];
+}
+interface GatewaySpendReportRow {
+    /** Date string (present when groupBy is 'day') */
+    day?: string;
+    /** Hour timestamp (present when groupBy is 'day' and datePart is 'hour') */
+    hour?: string;
+    /** User identifier (present when groupBy is 'user') */
+    user?: string;
+    /** Model identifier (present when groupBy is 'model') */
+    model?: string;
+    /** Tag value (present when groupBy is 'tag') */
+    tag?: string;
+    /** Provider name (present when groupBy is 'provider') */
+    provider?: string;
+    /** Credential type (present when groupBy is 'credential_type') */
+    credentialType?: 'byok' | 'system';
+    /** Total cost in USD */
+    totalCost: number;
+    /** Market cost in USD */
+    marketCost?: number;
+    /** Number of input tokens */
+    inputTokens?: number;
+    /** Number of output tokens */
+    outputTokens?: number;
+    /** Number of cached input tokens */
+    cachedInputTokens?: number;
+    /** Number of cache creation input tokens */
+    cacheCreationInputTokens?: number;
+    /** Number of reasoning tokens */
+    reasoningTokens?: number;
+    /** Number of requests */
+    requestCount?: number;
+}
+interface GatewaySpendReportResponse {
+    results: GatewaySpendReportRow[];
+}
+
 type GatewayEmbeddingModelId = 'alibaba/qwen3-embedding-0.6b' | 'alibaba/qwen3-embedding-4b' | 'alibaba/qwen3-embedding-8b' | 'amazon/titan-embed-text-v2' | 'cohere/embed-v4.0' | 'google/gemini-embedding-001' | 'google/gemini-embedding-2' | 'google/text-embedding-005' | 'google/text-multilingual-embedding-002' | 'mistral/codestral-embed' | 'mistral/mistral-embed' | 'openai/text-embedding-3-large' | 'openai/text-embedding-3-small' | 'openai/text-embedding-ada-002' | 'voyage/voyage-3-large' | 'voyage/voyage-3.5' | 'voyage/voyage-3.5-lite' | 'voyage/voyage-4' | 'voyage/voyage-4-large' | 'voyage/voyage-4-lite' | 'voyage/voyage-code-2' | 'voyage/voyage-code-3' | 'voyage/voyage-finance-2' | 'voyage/voyage-law-2' | (string & {});
 
 type GatewayImageModelId = 'bfl/flux-2-flex' | 'bfl/flux-2-klein-4b' | 'bfl/flux-2-klein-9b' | 'bfl/flux-2-max' | 'bfl/flux-2-pro' | 'bfl/flux-kontext-max' | 'bfl/flux-kontext-pro' | 'bfl/flux-pro-1.0-fill' | 'bfl/flux-pro-1.1' | 'bfl/flux-pro-1.1-ultra' | 'google/imagen-4.0-fast-generate-001' | 'google/imagen-4.0-generate-001' | 'google/imagen-4.0-ultra-generate-001' | 'openai/gpt-image-1' | 'openai/gpt-image-1-mini' | 'openai/gpt-image-1.5' | 'prodia/flux-fast-schnell' | 'recraft/recraft-v2' | 'recraft/recraft-v3' | 'recraft/recraft-v4' | 'recraft/recraft-v4-pro' | 'xai/grok-imagine-image' | 'xai/grok-imagine-image-pro' | (string & {});
@@ -370,6 +426,11 @@ interface GatewayProvider extends ProviderV4 {
      * Returns credit information for the authenticated user.
      */
     getCredits(): Promise<GatewayCreditsResponse>;
+    /**
+     * Returns a spend report with cost, token, and request count data,
+     * aggregated by the specified dimension.
+     */
+    getSpendReport(params: GatewaySpendReportParams): Promise<GatewaySpendReportResponse>;
     /**
      * Creates a model for generating text embeddings.
      */
@@ -599,4 +660,4 @@ declare class GatewayResponseError extends GatewayError {
     static isInstance(error: unknown): error is GatewayResponseError;
 }
 
-export { GatewayAuthenticationError, type GatewayCreditsResponse, GatewayError, type GatewayErrorResponse, GatewayInternalServerError, GatewayInvalidRequestError, type GatewayLanguageModelEntry, type GatewayProviderOptions as GatewayLanguageModelOptions, type GatewayLanguageModelSpecification, type GatewayLanguageModelEntry as GatewayModelEntry, type GatewayModelId, GatewayModelNotFoundError, type GatewayProvider, type GatewayProviderOptions, type GatewayProviderSettings, GatewayRateLimitError, GatewayResponseError, type GatewayVideoModelId, createGatewayProvider as createGateway, createGatewayProvider, gateway };
+export { GatewayAuthenticationError, type GatewayCreditsResponse, GatewayError, type GatewayErrorResponse, GatewayInternalServerError, GatewayInvalidRequestError, type GatewayLanguageModelEntry, type GatewayProviderOptions as GatewayLanguageModelOptions, type GatewayLanguageModelSpecification, type GatewayLanguageModelEntry as GatewayModelEntry, type GatewayModelId, GatewayModelNotFoundError, type GatewayProvider, type GatewayProviderOptions, type GatewayProviderSettings, GatewayRateLimitError, GatewayResponseError, type GatewaySpendReportParams, type GatewaySpendReportResponse, type GatewaySpendReportRow, type GatewayVideoModelId, createGatewayProvider as createGateway, createGatewayProvider, gateway };