Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion SDK.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,10 +209,24 @@ for (const item of results.organic) {
### Quota

```typescript
import {
isAccountBalanceResponse,
isQuotaResponse,
} from 'mmx-cli/sdk';

const quota = await sdk.quota.info();
console.log(quota);

if (isQuotaResponse(quota)) {
console.log(quota.model_remains);
} else if (isAccountBalanceResponse(quota)) {
console.log(quota.available_amount);
}
```

Token Plan credentials and OAuth return `QuotaResponse`. API secret keys with
the `sk-api-` prefix return `AccountBalanceResponse`. The type guards above
narrow the `QuotaInfoResponse` union without changing the raw API response.

## Custom Base URL

```typescript
Expand Down
33 changes: 30 additions & 3 deletions src/client/endpoints.ts
Original file line number Diff line number Diff line change
Expand Up @@ -62,10 +62,37 @@ export function isSecretApiKey(apiKey: string): boolean {
return apiKey.startsWith('sk-api-');
}

export type UsageEndpointKind = 'quota' | 'account-balance';

export interface UsageCredential {
token: string;
method: 'api-key' | 'oauth';
}

export interface UsageEndpointSelection {
url: string;
kind: UsageEndpointKind;
}

export function selectUsageEndpoint(
baseUrl: string,
credential: UsageCredential,
): UsageEndpointSelection {
if (credential.method === 'api-key' && isSecretApiKey(credential.token)) {
return {
url: accountBalanceEndpoint(baseUrl),
kind: 'account-balance',
};
}

return {
url: quotaEndpoint(baseUrl),
kind: 'quota',
};
}

export function usageEndpoint(baseUrl: string, apiKey: string): string {
return isSecretApiKey(apiKey)
? accountBalanceEndpoint(baseUrl)
: quotaEndpoint(baseUrl);
return selectUsageEndpoint(baseUrl, { token: apiKey, method: 'api-key' }).url;
}

export function fileUploadEndpoint(baseUrl: string): string {
Expand Down
22 changes: 9 additions & 13 deletions src/commands/quota/show.ts
Original file line number Diff line number Diff line change
@@ -1,15 +1,12 @@
import { defineCommand } from '../../command';
import { requestJson } from '../../client/http';
import { quotaEndpoint, usageEndpoint } from '../../client/endpoints';
import { selectUsageEndpoint } from '../../client/endpoints';
import { resolveCredential } from '../../auth/resolver';
import { formatOutput, detectOutputFormat } from '../../output/formatter';
import { renderUsage } from '../../output/usage';
import type { Config } from '../../config/schema';
import type { GlobalFlags } from '../../types/flags';
import type { AccountBalanceResponse, QuotaModelRemain } from '../../types/api';

interface QuotaApiResponse {
model_remains: QuotaModelRemain[];
}
import type { AccountBalanceResponse, QuotaResponse } from '../../types/api';

export default defineCommand({
name: 'quota show',
Expand All @@ -26,21 +23,20 @@ export default defineCommand({
}

const format = detectOutputFormat(flags.output as string | undefined);
const apiKey = config.apiKey || config.fileApiKey;
const credential = await resolveCredential(config);
const endpoint = selectUsageEndpoint(config.baseUrl, credential);

if (apiKey && apiKey.startsWith('sk-api-')) {
const url = usageEndpoint(config.baseUrl, apiKey);
const response = await requestJson<AccountBalanceResponse>(config, { url });
if (endpoint.kind === 'account-balance') {
const response = await requestJson<AccountBalanceResponse>(config, { url: endpoint.url });
if (format !== 'text') {
console.log(formatOutput(response, format));
return;
}
renderUsage(response, config, apiKey);
renderUsage(response, config, credential.token);
return;
}

const url = quotaEndpoint(config.baseUrl);
const response = await requestJson<QuotaApiResponse>(config, { url });
const response = await requestJson<QuotaResponse>(config, { url: endpoint.url });
const models = response.model_remains || [];

if (format !== 'text') {
Expand Down
10 changes: 10 additions & 0 deletions src/sdk/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,16 @@ import { FileSDK } from "./file";
import { Client } from "./client";
import { MiniMaxSDKOptions } from "./types";

export {
isAccountBalanceResponse,
isQuotaResponse,
} from "./quota";
export type {
AccountBalanceResponse,
QuotaInfoResponse,
QuotaResponse,
} from "./quota";

export class MiniMaxSDK extends Client {
readonly text: TextSDK;
readonly speech: SpeechSDK;
Expand Down
31 changes: 25 additions & 6 deletions src/sdk/quota/index.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,31 @@
import { Client } from "../client";
import { quotaEndpoint } from "../../client/endpoints";
import type { QuotaResponse } from "../../types/api";
import { selectUsageEndpoint } from "../../client/endpoints";
import { resolveCredential } from "../../auth/resolver";
import type { AccountBalanceResponse, QuotaResponse } from "../../types/api";

export type QuotaInfoResponse = QuotaResponse | AccountBalanceResponse;

export function isQuotaResponse(response: QuotaInfoResponse): response is QuotaResponse {
return 'model_remains' in response;
}

export function isAccountBalanceResponse(
response: QuotaInfoResponse,
): response is AccountBalanceResponse {
return 'available_amount' in response;
}

export class QuotaSDK extends Client {
async info(): Promise<QuotaResponse> {
const url = quotaEndpoint(this.config.baseUrl);
const res = await this.requestJson<QuotaResponse>({ url });
async info(): Promise<QuotaInfoResponse> {
const credential = await resolveCredential(this.config);
const endpoint = selectUsageEndpoint(this.config.baseUrl, credential);

if (endpoint.kind === 'account-balance') {
return this.requestJson<AccountBalanceResponse>({ url: endpoint.url });
}

return res;
return this.requestJson<QuotaResponse>({ url: endpoint.url });
}
}

export type { AccountBalanceResponse, QuotaResponse } from "../../types/api";
Loading
Loading