@picsart/ai-sdk 6.21.4 → 6.22.0

package/README.md

@@ -99,12 +99,12 @@ and keep needing `apiUrl` plus `fetch`/`apiKey` if you use them: `ai.drive` and
 | `submit(request)` | no | `generate()`, `submit()` — returns the generation id |
 | `poll(handle, options)` | no | `generate()`, `result()`, `subscribe()` — resolves when the job is terminal, calls `options.onProgress` on the way |
 | `status(handle, signal?)` | no | the edit-route probe behind `result(model, id)` on models that have one |
-| `options(workflow, payload)` | no | `getCredits()` — returns credits, or null |
+| `options(workflow, payload)` | no | `getCredits()` / `options()` — returns credits, an `OptionsResult`, or null |
 
 Leave `submit`/`poll` out and the client runs **every** generation through
 `execute()`; the async lifecycle (`submit()` / `result()` / `subscribe()`) then
 rejects with a 400 `unsupported_transport` rather than pretending. Leave
-`options` out and `getCredits()` answers null.
+`options` out and `getCredits()` / `options()` answer null.
 
 ```typescript
 import type { SdkTransport } from '@picsart/ai-sdk'

package/_vendor/workflows-client/index.d.ts

@@ -41,12 +41,13 @@ type PartialWorkflowResult<R> = {
     result: R;
 };
 interface WorkflowOptions {
-    monetization?: {
-        toolId: string;
-    };
+    toolId?: string;
     usageAmount?: number;
     credits?: number;
     originalCredits?: number;
+    estimated?: boolean;
+    unit?: string;
+    price?: number;
 }
 type HistoryResponse<R> = PicsartResponse & {
     response: {

package/index.d.ts

@@ -43,6 +43,26 @@ interface CreditUsage {
     /** The remaining balance. */
     balance?: number;
 }
+/**
+ * What a model's `/options` endpoint answers for one request — today its price
+ * and how it was derived (mirrors `WorkflowOptions` from `@picsart/workflows-client`).
+ */
+interface OptionsResult {
+    /** Monetization tool the request is billed under. */
+    toolId?: string;
+    /** Billable quantity, in `unit`s (e.g. seconds of video, tokens). */
+    usageAmount?: number;
+    /** Credits the request would be charged. */
+    credits: number;
+    /** Credits before any discount was applied. */
+    originalCredits?: number;
+    /** True when `credits` is a best guess rather than the exact charge — e.g. token-priced models, billed on actual usage. */
+    estimated?: boolean;
+    /** What `usageAmount` counts, e.g. "second" or "token". */
+    unit?: string;
+    /** Rate per `unit`. */
+    price?: number;
+}
 interface WorkflowPollOptions {
     intervalMs?: number;
     maxAttempts?: number;
@@ -93,8 +113,11 @@ interface SdkTransport<TPayload = Record<string, unknown>> {
     poll?(handle: WorkflowJobHandle, options?: TransportPollOptions): Promise<TransportResult>;
     /** Read a submitted job's current state in one request — no waiting. */
     status?(handle: WorkflowJobHandle, signal?: AbortSignal): Promise<TransportResult>;
-    /** Credits this request would cost, or null when pricing is unavailable. */
-    options?(workflow: string, payload: Record<string, unknown>): Promise<number | null>;
+    /**
+     * Credits this request would cost, or null when pricing is unavailable.
+     * Answer a bare number, or the full {@link OptionsResult} response.
+     */
+    options?(workflow: string, payload: Record<string, unknown>): Promise<number | OptionsResult | null>;
 }
 
 /**
@@ -3204,6 +3227,8 @@ interface AiClient {
     generateText<M extends TextModelId>(model: M, params: TextModelInputById[M], options?: GenerateOptions): Promise<GenerateTextResult>;
     /** Get exact credit cost for a model with specific parameters. */
     getCredits<M extends TypedModelId>(model: M, params: ModelInputById[M]): Promise<number | null>;
+    /** What the model's /options endpoint answers for these params — credits, how they were derived, and anything else it reports. */
+    options<M extends TypedModelId>(model: M, params: ModelInputById[M]): Promise<OptionsResult | null>;
     /** Submit a generation job and get its generation id back. Media models only. */
     submit<M extends MediaModelId>(model: M, params: ModelInputById[M], options?: GenerateOptions): Promise<string>;
     /** Poll a submitted job until it completes and return the parsed result. Media models only. */
@@ -3656,4 +3681,4 @@ declare const getModel: (id: string) => ModelDefinition | undefined;
  */
 declare const findModel: (ref: string) => ModelDefinition | undefined;
 
-export { ALL_MODELS, type AiClient, ApiError, type ApiErrorCode, type ApiErrorInit, type ApiResponse, type ApiRunOptions, type ApiSchemas, type ApisClient, type AppIdentity, type AppType, type AuthenticatedFetch, type AvatarOption, type BooleanDescriptor, type BooleanEntry, type CatalogDescriptor, type CatalogEntry, type CatalogItem, type CatalogPage, type CatalogPageOptions, type CatalogPreview, type CatalogQuery, type CatalogResult, type CatalogSource, type CatalogsClient, type CatalogsOptions, type ClientConfig, type CreditRange, type CreditRangeContext, type CreditTier, type CreditUsage, DEFAULT_VISIBLE_RELEASES, type DeepLinkResult, type DriveAttributes, type DriveClient, type DriveConfig, type DriveDraftInfo, type DriveFile, type DriveFileDetails, type DriveFolder, type DriveMediaItem, type DriveSaveResult, type EntryMeta, type EnumDescriptor, type EnumEntry, type EnumOption, type FileDescriptor, type FileEntry, type FlatParamEntry, type GenerateOptions, type GenerateResult, type GenerateResultItem, type GenerateResultItemMetadata, type GenerateTextResult, type GenerationContext, type GenerationEvent, GenerationEventType, type GenerationFile, type GenerationMode, type GenerationOptions, type GenerationProgress, type GenerationProvenance, type ListOptions, type MediaModelId, type MediaTypeFilter, Model, type ModelDefinition, type ModelDescriptor, type ModelFilter, type ModelInput, type ModelInputById, type ModelMeta, type ModelParams, type ModelParamsAccessor, Models, type ObjectDescriptor, type ObjectEntry, type ParamDescriptor, type ParamEntry, type ParamOption, type PayloadDriveFolderOptions, type PayloadDriveOptions, type PayloadInputsTransformationOptions, type PricingOptions, type ProviderInfo, type RangeDescriptor, type RangeEntry, type ReleaseTag, type SaveParams, type SdkPayload, type SdkTransport, type SeedanceDraftTask, type TextDescriptor, type TextEntry, type TextModelId, type TextModelInputById, type ToolUsage, type TransportPollOptions, type TransportResult, type TypedModelId, type UserReaction, type ValidationResult, type VoiceOption, type WorkflowJobHandle, type WorkflowSubmitRequest, buildFilename, buildGenerationAttributes, catalog, createClient, decodeDeepLinkPayload, encodeDeepLinkPayload, expectedOutputFormat, findModel, getModel, getModelsByMode, getVoiceById, inferResourceType, isVisibleForReleases, parseGeneration, releaseOf, resolveExtension, toAvatarOption, toVoiceOption };
+export { ALL_MODELS, type AiClient, ApiError, type ApiErrorCode, type ApiErrorInit, type ApiResponse, type ApiRunOptions, type ApiSchemas, type ApisClient, type AppIdentity, type AppType, type AuthenticatedFetch, type AvatarOption, type BooleanDescriptor, type BooleanEntry, type CatalogDescriptor, type CatalogEntry, type CatalogItem, type CatalogPage, type CatalogPageOptions, type CatalogPreview, type CatalogQuery, type CatalogResult, type CatalogSource, type CatalogsClient, type CatalogsOptions, type ClientConfig, type CreditRange, type CreditRangeContext, type CreditTier, type CreditUsage, DEFAULT_VISIBLE_RELEASES, type DeepLinkResult, type DriveAttributes, type DriveClient, type DriveConfig, type DriveDraftInfo, type DriveFile, type DriveFileDetails, type DriveFolder, type DriveMediaItem, type DriveSaveResult, type EntryMeta, type EnumDescriptor, type EnumEntry, type EnumOption, type FileDescriptor, type FileEntry, type FlatParamEntry, type GenerateOptions, type GenerateResult, type GenerateResultItem, type GenerateResultItemMetadata, type GenerateTextResult, type GenerationContext, type GenerationEvent, GenerationEventType, type GenerationFile, type GenerationMode, type GenerationOptions, type GenerationProgress, type GenerationProvenance, type ListOptions, type MediaModelId, type MediaTypeFilter, Model, type ModelDefinition, type ModelDescriptor, type ModelFilter, type ModelInput, type ModelInputById, type ModelMeta, type ModelParams, type ModelParamsAccessor, Models, type ObjectDescriptor, type ObjectEntry, type OptionsResult, type ParamDescriptor, type ParamEntry, type ParamOption, type PayloadDriveFolderOptions, type PayloadDriveOptions, type PayloadInputsTransformationOptions, type PricingOptions, type ProviderInfo, type RangeDescriptor, type RangeEntry, type ReleaseTag, type SaveParams, type SdkPayload, type SdkTransport, type SeedanceDraftTask, type TextDescriptor, type TextEntry, type TextModelId, type TextModelInputById, type ToolUsage, type TransportPollOptions, type TransportResult, type TypedModelId, type UserReaction, type ValidationResult, type VoiceOption, type WorkflowJobHandle, type WorkflowSubmitRequest, buildFilename, buildGenerationAttributes, catalog, createClient, decodeDeepLinkPayload, encodeDeepLinkPayload, expectedOutputFormat, findModel, getModel, getModelsByMode, getVoiceById, inferResourceType, isVisibleForReleases, parseGeneration, releaseOf, resolveExtension, toAvatarOption, toVoiceOption };

package/index.js

@@ -12247,7 +12247,8 @@ function buildTransport(wc) {
     async options(workflow, payload) {
       try {
         const res = await wc.options(workflow, payload);
-        return typeof res?.credits === "number" ? res.credits : null;
+        if (typeof res?.credits !== "number") return null;
+        return { ...res, credits: res.credits };
       } catch {
         return null;
       }
@@ -13235,6 +13236,14 @@ function createClient(config) {
       }
     };
   }
+  async function fetchOptions(model, params2) {
+    if (!transport.options) return null;
+    const resolved = resolveModel(model);
+    const { workflow, payload } = prepareRequest(resolved, params2);
+    const res = await transport.options(workflow, payload);
+    if (typeof res === "number") return { credits: res };
+    return res && typeof res.credits === "number" ? res : null;
+  }
   async function resolveJobHandle(model, generationId, signal) {
     const primary = { workflow: model.workflow, id: generationId };
     if (!model.editWorkflow || !transport.status) return primary;
@@ -13294,10 +13303,14 @@ function createClient(config) {
      * Returns null if pricing is unavailable.
      */
     async getCredits(model, params2) {
-      if (!transport.options) return null;
-      const resolved = resolveModel(model);
-      const { workflow, payload } = prepareRequest(resolved, params2);
-      return await transport.options(workflow, payload) ?? null;
+      return (await fetchOptions(model, params2))?.credits ?? null;
+    },
+    /**
+     * Same /options call as getCredits(), returning the whole response:
+     * credits plus billable amount, unit, rate, and whether they are estimated.
+     */
+    async options(model, params2) {
+      return fetchOptions(model, params2);
     },
     /** Build the vendor-specific payload for a model without submitting. */
     buildPayload(model, params2) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@picsart/ai-sdk",
-  "version": "6.21.4",
+  "version": "6.22.0",
   "type": "module",
   "description": "Type-safe SDK for 100+ AI models — image, video, audio, and text generation with Picsart",
   "license": "MIT",