@curvet/sdk 0.1.0 → 0.2.1

package/dist/index.d.cts

@@ -29,7 +29,7 @@ interface FetchResponse {
 interface FetchInit {
     method?: string;
     headers?: Record<string, string>;
-    body?: string;
+    body?: string | FormData;
     signal?: AbortSignal;
 }
 /** Injectable fetch implementation (defaults to global fetch on Node 18+). */
@@ -173,6 +173,17 @@ interface VideoGenerateParams {
     resolution?: string;
     [key: string]: unknown;
 }
+interface AudioGenerateParams {
+    model: ModelId;
+    prompt: string;
+    voice?: string;
+    [key: string]: unknown;
+}
+interface ThreeDGenerateParams {
+    model: ModelId;
+    prompt: string;
+    [key: string]: unknown;
+}
 interface PollOptions {
     /** Poll interval in ms (default 2500). */
     pollIntervalMs?: number;
@@ -211,32 +222,46 @@ declare class Job {
     wait(opts?: PollOptions): Promise<MediaJob>;
 }
 
+interface MediaParamsBase {
+    model: string;
+    prompt: string;
+    [key: string]: unknown;
+}
 /**
- * Video generation. Backed by an async job queue: `generate()` submits and
- * polls to completion (the common case); `submit()` fires and returns the job
- * handle for manual polling.
+ * Generic engine for the async media endpoints (video / audio / 3d). They all
+ * enqueue the same server-side job queue, so they share one implementation
+ * parameterized by `path` and request param type.
  *
- * The same implementation backs audio and 3D (v1.1) via the `path` arg.
+ * `generate()` submits and polls to completion; `submit()` fires without polling.
  */
-declare class Video {
-    private client;
-    private defaults;
-    private path;
-    constructor(client: HttpClient, defaults: JobDefaults, path?: string);
-    /**
-     * Submit a job WITHOUT polling. Returns once the server responds — either the
-     * 200 fast-path (already done) or a 202 with a jobId.
-     *
-     * The media POST long-polls server-side and can block well past a normal
-     * request timeout, so we default its timeout to the poll budget and disable
-     * auto-retry (a retried POST would enqueue a duplicate, double-charged job).
-     */
-    submit(params: VideoGenerateParams, options?: RequestOptions): Promise<MediaJob>;
+declare class MediaResource<P extends MediaParamsBase> {
+    protected client: HttpClient;
+    protected defaults: JobDefaults;
+    protected path: string;
+    constructor(client: HttpClient, defaults: JobDefaults, path: string);
     /**
-     * Submit and resolve to the finished media. Handles the 200-vs-202 split and
-     * polls `/jobs/:id` internally. Throws JobFailedError / JobTimeoutError.
+     * Submit WITHOUT polling. The media POST long-polls server-side and can block
+     * well past a normal request timeout, so we default its timeout to the poll
+     * budget and disable auto-retry (a retried POST would enqueue a duplicate job).
      */
-    generate(params: VideoGenerateParams, options?: RequestOptions & PollOptions): Promise<MediaJob>;
+    submit(params: P, options?: RequestOptions): Promise<MediaJob>;
+    /** Submit and resolve to the finished media (auto-polls /jobs/:id). */
+    generate(params: P, options?: RequestOptions & PollOptions): Promise<MediaJob>;
+}
+
+/** Video generation (async). `curvet.video.generate(...)` auto-polls to completion. */
+declare class Video extends MediaResource<VideoGenerateParams> {
+    constructor(client: HttpClient, defaults: JobDefaults);
+}
+
+/** Audio generation (async). `curvet.audio.generate(...)` auto-polls to completion. */
+declare class Audio extends MediaResource<AudioGenerateParams> {
+    constructor(client: HttpClient, defaults: JobDefaults);
+}
+
+/** 3D model generation (async). `curvet.threeD.generate(...)` auto-polls to completion. */
+declare class ThreeD extends MediaResource<ThreeDGenerateParams> {
+    constructor(client: HttpClient, defaults: JobDefaults);
 }
 
 interface ModelsListOptions extends RequestOptions {
@@ -285,11 +310,115 @@ declare class Balance {
     get(options?: RequestOptions): Promise<BalanceInfo>;
 }
 
+interface AnalyticsParams extends RequestOptions {
+    /** ISO 8601 start date. */
+    startDate?: string;
+    /** ISO 8601 end date. */
+    endDate?: string;
+}
+interface AnalyticsResult {
+    totalRequests?: number;
+    totalCost?: number;
+    requestsByModel?: Record<string, number>;
+    requestsByCategory?: Record<string, number>;
+    [key: string]: unknown;
+}
+declare class Analytics {
+    private client;
+    constructor(client: HttpClient);
+    /** Usage analytics for the app, optionally bounded by a date range. */
+    get(params?: AnalyticsParams): Promise<AnalyticsResult>;
+}
+
+interface WorkflowRunParams {
+    /** Input values for the workflow. */
+    inputs?: Record<string, unknown>;
+    /** Optional file inputs, keyed by the workflow's file field name. */
+    files?: Record<string, Blob>;
+    /** Include the full execution state in the response (default true server-side). */
+    includeFullState?: boolean;
+}
+interface WorkflowRunResult {
+    success: boolean;
+    [key: string]: unknown;
+}
+declare class Workflows {
+    private client;
+    constructor(client: HttpClient);
+    /**
+     * Execute a visual-builder workflow by id. Sends JSON when there are no file
+     * inputs, multipart/form-data when files are provided. Not auto-retried (a
+     * workflow run executes and may consume credits).
+     */
+    run(id: string, params?: WorkflowRunParams, options?: RequestOptions): Promise<WorkflowRunResult>;
+}
+
+interface FoodItem {
+    [key: string]: unknown;
+}
+/**
+ * Indian Food Dataset API. Mounted as a sibling of the playground under
+ * `/api/v1/food`, so it uses the v1-root HTTP client. Requires the app to have
+ * Food API access enabled.
+ */
+declare class Food {
+    private client;
+    constructor(client: HttpClient);
+    /** List dishes (default limit 20). */
+    list(opts?: {
+        limit?: number;
+    } & RequestOptions): Promise<FoodItem[]>;
+    /** Full-text search for dishes. */
+    search(query: string, opts?: {
+        limit?: number;
+    } & RequestOptions): Promise<FoodItem[]>;
+    /** Natural-language dish recommendations. */
+    recommendations(prompt: string, options?: RequestOptions): Promise<FoodItem[]>;
+}
+
+interface SttParams {
+    /** The audio to transcribe. */
+    audio: Blob | Uint8Array | ArrayBuffer;
+    /** File name for the upload (default "audio"). */
+    filename?: string;
+    provider?: "elevenlabs" | "deepinfra" | (string & {});
+    /** ASR model id (provider-specific; optional). */
+    model?: string;
+    prompt?: string;
+    /** ISO 639-1 language hint. */
+    languageCode?: string;
+    allowFallback?: boolean;
+}
+interface SttResult {
+    success: boolean;
+    text: string;
+    languageCode?: string;
+    segments?: Array<{
+        start: number;
+        end: number;
+        text: string;
+    }>;
+    provider?: string;
+    creditsCharged?: number;
+    creditsRemaining?: number;
+    [key: string]: unknown;
+}
+/**
+ * Public speech-to-text. Mounted as a sibling of the playground under
+ * `/api/v1/voice`, so it uses the v1-root HTTP client. Multipart upload; not
+ * auto-retried (it consumes credits).
+ */
+declare class Voice {
+    private client;
+    constructor(client: HttpClient);
+    stt(params: SttParams, options?: RequestOptions): Promise<SttResult>;
+}
+
 declare const DEFAULT_BASE_URL = "https://curvet.ai/api/v1/playground";
 interface CurvetOptions {
     /** Your app key. Falls back to the CURVET_APP_KEY env var. */
     appKey?: string;
-    /** Override the gateway base URL (defaults to production). */
+    /** Override the playground base URL (defaults to production). */
     baseURL?: string;
     /** Per-request timeout in ms (default 60000). */
     timeout?: number;
@@ -317,9 +446,15 @@ declare class Curvet {
     readonly chat: Chat;
     readonly image: Images;
     readonly video: Video;
+    readonly audio: Audio;
+    readonly threeD: ThreeD;
     readonly jobs: Jobs;
     readonly models: Models;
     readonly balance: Balance;
+    readonly analytics: Analytics;
+    readonly workflows: Workflows;
+    readonly food: Food;
+    readonly voice: Voice;
     constructor(options?: CurvetOptions);
 }
 
@@ -377,4 +512,4 @@ declare class JobTimeoutError extends CurvetError {
     constructor(message: string, jobId: string, opts?: CurvetErrorOptions);
 }
 
-export { APIError, AuthError, BadRequestError, Balance, type BalanceInfo, Chat, type ChatCreateParams, type ChatMessage, type ChatResponse, type ChatRole, ConnectionError, Curvet, CurvetError, type CurvetErrorOptions, type CurvetOptions, DEFAULT_BASE_URL, type FetchLike, type ImageGenerateParams, type ImageResponse, Images, InsufficientBalanceError, Job, type JobDefaults, JobFailedError, type JobStatus, JobTimeoutError, Jobs, type KnownModelId, type MediaJob, type MediaKind, type ModelId, type ModelInfo, type ModelType, Models, type ModelsListOptions, NotFoundError, PermissionError, type PollOptions, RateLimitError, type RateLimits, type RequestOptions, type Usage, Video, type VideoGenerateParams };
+export { APIError, Analytics, type AnalyticsParams, type AnalyticsResult, Audio, type AudioGenerateParams, AuthError, BadRequestError, Balance, type BalanceInfo, Chat, type ChatCreateParams, type ChatMessage, type ChatResponse, type ChatRole, ConnectionError, Curvet, CurvetError, type CurvetErrorOptions, type CurvetOptions, DEFAULT_BASE_URL, type FetchLike, Food, type FoodItem, type ImageGenerateParams, type ImageResponse, Images, InsufficientBalanceError, Job, type JobDefaults, JobFailedError, type JobStatus, JobTimeoutError, Jobs, type KnownModelId, type MediaJob, type MediaKind, type MediaParamsBase, MediaResource, type ModelId, type ModelInfo, type ModelType, Models, type ModelsListOptions, NotFoundError, PermissionError, type PollOptions, RateLimitError, type RateLimits, type RequestOptions, type SttParams, type SttResult, ThreeD, type ThreeDGenerateParams, type Usage, Video, type VideoGenerateParams, Voice, type WorkflowRunParams, type WorkflowRunResult, Workflows };

package/dist/index.d.ts

@@ -29,7 +29,7 @@ interface FetchResponse {
 interface FetchInit {
     method?: string;
     headers?: Record<string, string>;
-    body?: string;
+    body?: string | FormData;
     signal?: AbortSignal;
 }
 /** Injectable fetch implementation (defaults to global fetch on Node 18+). */
@@ -173,6 +173,17 @@ interface VideoGenerateParams {
     resolution?: string;
     [key: string]: unknown;
 }
+interface AudioGenerateParams {
+    model: ModelId;
+    prompt: string;
+    voice?: string;
+    [key: string]: unknown;
+}
+interface ThreeDGenerateParams {
+    model: ModelId;
+    prompt: string;
+    [key: string]: unknown;
+}
 interface PollOptions {
     /** Poll interval in ms (default 2500). */
     pollIntervalMs?: number;
@@ -211,32 +222,46 @@ declare class Job {
     wait(opts?: PollOptions): Promise<MediaJob>;
 }
 
+interface MediaParamsBase {
+    model: string;
+    prompt: string;
+    [key: string]: unknown;
+}
 /**
- * Video generation. Backed by an async job queue: `generate()` submits and
- * polls to completion (the common case); `submit()` fires and returns the job
- * handle for manual polling.
+ * Generic engine for the async media endpoints (video / audio / 3d). They all
+ * enqueue the same server-side job queue, so they share one implementation
+ * parameterized by `path` and request param type.
  *
- * The same implementation backs audio and 3D (v1.1) via the `path` arg.
+ * `generate()` submits and polls to completion; `submit()` fires without polling.
  */
-declare class Video {
-    private client;
-    private defaults;
-    private path;
-    constructor(client: HttpClient, defaults: JobDefaults, path?: string);
-    /**
-     * Submit a job WITHOUT polling. Returns once the server responds — either the
-     * 200 fast-path (already done) or a 202 with a jobId.
-     *
-     * The media POST long-polls server-side and can block well past a normal
-     * request timeout, so we default its timeout to the poll budget and disable
-     * auto-retry (a retried POST would enqueue a duplicate, double-charged job).
-     */
-    submit(params: VideoGenerateParams, options?: RequestOptions): Promise<MediaJob>;
+declare class MediaResource<P extends MediaParamsBase> {
+    protected client: HttpClient;
+    protected defaults: JobDefaults;
+    protected path: string;
+    constructor(client: HttpClient, defaults: JobDefaults, path: string);
     /**
-     * Submit and resolve to the finished media. Handles the 200-vs-202 split and
-     * polls `/jobs/:id` internally. Throws JobFailedError / JobTimeoutError.
+     * Submit WITHOUT polling. The media POST long-polls server-side and can block
+     * well past a normal request timeout, so we default its timeout to the poll
+     * budget and disable auto-retry (a retried POST would enqueue a duplicate job).
      */
-    generate(params: VideoGenerateParams, options?: RequestOptions & PollOptions): Promise<MediaJob>;
+    submit(params: P, options?: RequestOptions): Promise<MediaJob>;
+    /** Submit and resolve to the finished media (auto-polls /jobs/:id). */
+    generate(params: P, options?: RequestOptions & PollOptions): Promise<MediaJob>;
+}
+
+/** Video generation (async). `curvet.video.generate(...)` auto-polls to completion. */
+declare class Video extends MediaResource<VideoGenerateParams> {
+    constructor(client: HttpClient, defaults: JobDefaults);
+}
+
+/** Audio generation (async). `curvet.audio.generate(...)` auto-polls to completion. */
+declare class Audio extends MediaResource<AudioGenerateParams> {
+    constructor(client: HttpClient, defaults: JobDefaults);
+}
+
+/** 3D model generation (async). `curvet.threeD.generate(...)` auto-polls to completion. */
+declare class ThreeD extends MediaResource<ThreeDGenerateParams> {
+    constructor(client: HttpClient, defaults: JobDefaults);
 }
 
 interface ModelsListOptions extends RequestOptions {
@@ -285,11 +310,115 @@ declare class Balance {
     get(options?: RequestOptions): Promise<BalanceInfo>;
 }
 
+interface AnalyticsParams extends RequestOptions {
+    /** ISO 8601 start date. */
+    startDate?: string;
+    /** ISO 8601 end date. */
+    endDate?: string;
+}
+interface AnalyticsResult {
+    totalRequests?: number;
+    totalCost?: number;
+    requestsByModel?: Record<string, number>;
+    requestsByCategory?: Record<string, number>;
+    [key: string]: unknown;
+}
+declare class Analytics {
+    private client;
+    constructor(client: HttpClient);
+    /** Usage analytics for the app, optionally bounded by a date range. */
+    get(params?: AnalyticsParams): Promise<AnalyticsResult>;
+}
+
+interface WorkflowRunParams {
+    /** Input values for the workflow. */
+    inputs?: Record<string, unknown>;
+    /** Optional file inputs, keyed by the workflow's file field name. */
+    files?: Record<string, Blob>;
+    /** Include the full execution state in the response (default true server-side). */
+    includeFullState?: boolean;
+}
+interface WorkflowRunResult {
+    success: boolean;
+    [key: string]: unknown;
+}
+declare class Workflows {
+    private client;
+    constructor(client: HttpClient);
+    /**
+     * Execute a visual-builder workflow by id. Sends JSON when there are no file
+     * inputs, multipart/form-data when files are provided. Not auto-retried (a
+     * workflow run executes and may consume credits).
+     */
+    run(id: string, params?: WorkflowRunParams, options?: RequestOptions): Promise<WorkflowRunResult>;
+}
+
+interface FoodItem {
+    [key: string]: unknown;
+}
+/**
+ * Indian Food Dataset API. Mounted as a sibling of the playground under
+ * `/api/v1/food`, so it uses the v1-root HTTP client. Requires the app to have
+ * Food API access enabled.
+ */
+declare class Food {
+    private client;
+    constructor(client: HttpClient);
+    /** List dishes (default limit 20). */
+    list(opts?: {
+        limit?: number;
+    } & RequestOptions): Promise<FoodItem[]>;
+    /** Full-text search for dishes. */
+    search(query: string, opts?: {
+        limit?: number;
+    } & RequestOptions): Promise<FoodItem[]>;
+    /** Natural-language dish recommendations. */
+    recommendations(prompt: string, options?: RequestOptions): Promise<FoodItem[]>;
+}
+
+interface SttParams {
+    /** The audio to transcribe. */
+    audio: Blob | Uint8Array | ArrayBuffer;
+    /** File name for the upload (default "audio"). */
+    filename?: string;
+    provider?: "elevenlabs" | "deepinfra" | (string & {});
+    /** ASR model id (provider-specific; optional). */
+    model?: string;
+    prompt?: string;
+    /** ISO 639-1 language hint. */
+    languageCode?: string;
+    allowFallback?: boolean;
+}
+interface SttResult {
+    success: boolean;
+    text: string;
+    languageCode?: string;
+    segments?: Array<{
+        start: number;
+        end: number;
+        text: string;
+    }>;
+    provider?: string;
+    creditsCharged?: number;
+    creditsRemaining?: number;
+    [key: string]: unknown;
+}
+/**
+ * Public speech-to-text. Mounted as a sibling of the playground under
+ * `/api/v1/voice`, so it uses the v1-root HTTP client. Multipart upload; not
+ * auto-retried (it consumes credits).
+ */
+declare class Voice {
+    private client;
+    constructor(client: HttpClient);
+    stt(params: SttParams, options?: RequestOptions): Promise<SttResult>;
+}
+
 declare const DEFAULT_BASE_URL = "https://curvet.ai/api/v1/playground";
 interface CurvetOptions {
     /** Your app key. Falls back to the CURVET_APP_KEY env var. */
     appKey?: string;
-    /** Override the gateway base URL (defaults to production). */
+    /** Override the playground base URL (defaults to production). */
     baseURL?: string;
     /** Per-request timeout in ms (default 60000). */
     timeout?: number;
@@ -317,9 +446,15 @@ declare class Curvet {
     readonly chat: Chat;
     readonly image: Images;
     readonly video: Video;
+    readonly audio: Audio;
+    readonly threeD: ThreeD;
     readonly jobs: Jobs;
     readonly models: Models;
     readonly balance: Balance;
+    readonly analytics: Analytics;
+    readonly workflows: Workflows;
+    readonly food: Food;
+    readonly voice: Voice;
     constructor(options?: CurvetOptions);
 }
 
@@ -377,4 +512,4 @@ declare class JobTimeoutError extends CurvetError {
     constructor(message: string, jobId: string, opts?: CurvetErrorOptions);
 }
 
-export { APIError, AuthError, BadRequestError, Balance, type BalanceInfo, Chat, type ChatCreateParams, type ChatMessage, type ChatResponse, type ChatRole, ConnectionError, Curvet, CurvetError, type CurvetErrorOptions, type CurvetOptions, DEFAULT_BASE_URL, type FetchLike, type ImageGenerateParams, type ImageResponse, Images, InsufficientBalanceError, Job, type JobDefaults, JobFailedError, type JobStatus, JobTimeoutError, Jobs, type KnownModelId, type MediaJob, type MediaKind, type ModelId, type ModelInfo, type ModelType, Models, type ModelsListOptions, NotFoundError, PermissionError, type PollOptions, RateLimitError, type RateLimits, type RequestOptions, type Usage, Video, type VideoGenerateParams };
+export { APIError, Analytics, type AnalyticsParams, type AnalyticsResult, Audio, type AudioGenerateParams, AuthError, BadRequestError, Balance, type BalanceInfo, Chat, type ChatCreateParams, type ChatMessage, type ChatResponse, type ChatRole, ConnectionError, Curvet, CurvetError, type CurvetErrorOptions, type CurvetOptions, DEFAULT_BASE_URL, type FetchLike, Food, type FoodItem, type ImageGenerateParams, type ImageResponse, Images, InsufficientBalanceError, Job, type JobDefaults, JobFailedError, type JobStatus, JobTimeoutError, Jobs, type KnownModelId, type MediaJob, type MediaKind, type MediaParamsBase, MediaResource, type ModelId, type ModelInfo, type ModelType, Models, type ModelsListOptions, NotFoundError, PermissionError, type PollOptions, RateLimitError, type RateLimits, type RequestOptions, type SttParams, type SttResult, ThreeD, type ThreeDGenerateParams, type Usage, Video, type VideoGenerateParams, Voice, type WorkflowRunParams, type WorkflowRunResult, Workflows };