litellm-api 0.0.3 → 1.1.0

package/README.md

@@ -1,11 +1,55 @@
-# LiteLLM API JavaScript SDK
+# litellm-api
 
-Unofficial LiteLLM API JavaScript SDK built from the OpenAPI specification and with TypeScript types.
+Auto-generated, fully typed client for the [LiteLLM proxy API](https://docs.litellm.ai/docs/proxy/quick_start).
+
+## Features
+
+- **Fully typed** - every operation, parameter and response is generated from the official OpenAPI spec
+- **Tree-shakable** - only the operations you import end up in your bundle
+- **Runtime agnostic** - uses the global `fetch`, or bring your own implementation
+
+## Installation
+
+```bash
+npm install litellm-api
+```
+
+## Quick Start
+
+LiteLLM is self-hosted, so the client requires the `baseUrl` of your proxy:
 
 ```ts
-const litellm = new LiteLLMApi({ baseUrl, token });
+import { LiteLLMApi } from "litellm-api";
+
+const client = new LiteLLMApi({
+  baseUrl: "http://localhost:4000",
+  token: process.env.LITELLM_MASTER_KEY ?? null,
+});
 
-const assistants = await litellm.request('GET /assistants', {});
+const usage = await client.api.billing.checkUsageBillingUsageGet();
+```
+
+Operations are grouped by tag: `client.api.<tag>.<operation>(params)`.
 
-const models = await litellm.api.modelManagement.modelListModelsGet({ queryParams: { team_id } });
+### Custom fetch
+
+```ts
+const client = new LiteLLMApi({
+  baseUrl: "http://localhost:4000",
+  token: process.env.LITELLM_MASTER_KEY ?? null,
+  fetch: myFetchImplementation,
+});
 ```
+
+## Entrypoints
+
+| Import | Contents |
+| --- | --- |
+| `litellm-api` | client class, operations, schemas and types |
+| `litellm-api/components` | operations grouped by tag and by path |
+| `litellm-api/schemas` | Zod schemas for every operation |
+| `litellm-api/types` | TypeScript types for every operation |
+
+## License
+
+ISC

package/dist/components-e9x5e8kj.js

@@ -0,0 +1,149 @@
+function notEmpty(value) {
+    return value !== null && value !== undefined;
+}
+function compactObject(obj) {
+    return Object.fromEntries(Object.entries(obj).filter(([, value])=>notEmpty(value)));
+}
+
+async function client({ url, method, body, headers, pathParams, queryParams, signal, baseUrl = "", token = null, fetchImpl = fetch }) {
+    try {
+        const requestHeaders = compactObject({
+            "Content-Type": "application/json",
+            Authorization: token ? `Bearer ${token}` : undefined,
+            ...headers
+        });
+        if (requestHeaders["Content-Type"]?.toLowerCase().includes("multipart/form-data")) {
+            delete requestHeaders["Content-Type"];
+        }
+        const payload = body instanceof FormData ? body : requestHeaders["Content-Type"] === "application/json" ? JSON.stringify(body) : body;
+        const fullUrl = `${baseUrl}${resolveUrl(url, queryParams, pathParams)}`;
+        const response = await fetchImpl(fullUrl, {
+            signal,
+            method: method.toUpperCase(),
+            body: payload,
+            headers: requestHeaders
+        });
+        if (!response.ok) {
+            let error;
+            try {
+                error = await response.json();
+            } catch (e) {
+                error = {
+                    status: "unknown",
+                    payload: e instanceof Error ? `Unexpected error (${e.message})` : "Unexpected error"
+                };
+            }
+            throw error;
+        }
+        if (response.headers?.get("content-type")?.includes("json")) {
+            return await response.json();
+        } else {
+            return await response.text();
+        }
+    } catch (e) {
+        const errorObject = {
+            name: "unknown",
+            message: e instanceof Error ? `Network error (${e.message})` : "Network error",
+            stack: e
+        };
+        throw errorObject;
+    }
+}
+const resolveUrl = (url, queryParams = {}, pathParams = {})=>{
+    let query = new URLSearchParams(queryParams).toString();
+    if (query) query = `?${query}`;
+    return url.replace(/\{\w*\}/g, (key)=>pathParams[key.slice(1, -1)] ?? "") + query;
+};
+
+/**
+ * @summary Create a Stripe Checkout session for API access
+ * @description Returns a Stripe Checkout URL. After payment, you'll receive an API key.
+ * @link /billing/checkout
+ */ async function createCheckoutBillingCheckoutPost({ config } = {}) {
+    const { client: request = client, ...requestConfig } = config ?? {};
+    const data = await request({
+        method: "POST",
+        url: `/billing/checkout`,
+        ...requestConfig,
+        headers: {
+            ...requestConfig.headers
+        }
+    });
+    return data;
+}
+/**
+ * @summary Check your free-tier usage
+ * @description See how many requests you've used today (free tier, by IP).
+ * @link /billing/usage
+ */ async function checkUsageBillingUsageGet({ config } = {}) {
+    const { client: request = client, ...requestConfig } = config ?? {};
+    const data = await request({
+        method: "GET",
+        url: `/billing/usage`,
+        ...requestConfig,
+        headers: {
+            ...requestConfig.headers
+        }
+    });
+    return data;
+}
+/**
+ * @summary List the full LiteLLM model catalog
+ * @description Returns model pricing, context window sizes, and capability metadata from LiteLLM's built-in catalog. Supports filtering by provider, mode, model name pattern, and pagination.
+ * @link /model_catalog
+ */ async function listModelCatalogModelCatalogGet({ queryParams, config } = {}) {
+    const { client: request = client, ...requestConfig } = config ?? {};
+    const data = await request({
+        method: "GET",
+        url: `/model_catalog`,
+        queryParams,
+        ...requestConfig,
+        headers: {
+            ...requestConfig.headers
+        }
+    });
+    return data;
+}
+/**
+ * @summary Get a single model from the catalog
+ * @description Returns detailed information for a specific model by its exact ID.
+ * @link /model_catalog/{model_id}
+ */ async function getModelCatalogEntryModelCatalogModelIdGet({ pathParams, config } = {}) {
+    const { client: request = client, ...requestConfig } = config ?? {};
+    if (!pathParams.model_id) {
+        throw new Error(`Missing required path parameter: model_id`);
+    }
+    const data = await request({
+        method: "GET",
+        url: `/model_catalog/${pathParams.model_id}`,
+        ...requestConfig,
+        headers: {
+            ...requestConfig.headers
+        }
+    });
+    return data;
+}
+const operationsByPath = {
+    "POST /billing/checkout": createCheckoutBillingCheckoutPost,
+    "GET /billing/usage": checkUsageBillingUsageGet,
+    "GET /model_catalog": listModelCatalogModelCatalogGet,
+    "GET /model_catalog/{model_id}": getModelCatalogEntryModelCatalogModelIdGet
+};
+const operationsByTag = {
+    billing: {
+        createCheckoutBillingCheckoutPost,
+        checkUsageBillingUsageGet
+    }
+};
+const tagDictionary = {
+    billing: {
+        POST: [
+            "createCheckoutBillingCheckoutPost"
+        ],
+        GET: [
+            "checkUsageBillingUsageGet"
+        ]
+    }
+};
+
+export { operationsByPath as a, checkUsageBillingUsageGet as b, client as c, createCheckoutBillingCheckoutPost as d, getModelCatalogEntryModelCatalogModelIdGet as g, listModelCatalogModelCatalogGet as l, operationsByTag as o, tagDictionary as t };

package/dist/components-g21ikhwl.cjs

@@ -0,0 +1,156 @@
+function notEmpty(value) {
+    return value !== null && value !== undefined;
+}
+function compactObject(obj) {
+    return Object.fromEntries(Object.entries(obj).filter(([, value])=>notEmpty(value)));
+}
+
+async function client({ url, method, body, headers, pathParams, queryParams, signal, baseUrl = "", token = null, fetchImpl = fetch }) {
+    try {
+        const requestHeaders = compactObject({
+            "Content-Type": "application/json",
+            Authorization: token ? `Bearer ${token}` : undefined,
+            ...headers
+        });
+        if (requestHeaders["Content-Type"]?.toLowerCase().includes("multipart/form-data")) {
+            delete requestHeaders["Content-Type"];
+        }
+        const payload = body instanceof FormData ? body : requestHeaders["Content-Type"] === "application/json" ? JSON.stringify(body) : body;
+        const fullUrl = `${baseUrl}${resolveUrl(url, queryParams, pathParams)}`;
+        const response = await fetchImpl(fullUrl, {
+            signal,
+            method: method.toUpperCase(),
+            body: payload,
+            headers: requestHeaders
+        });
+        if (!response.ok) {
+            let error;
+            try {
+                error = await response.json();
+            } catch (e) {
+                error = {
+                    status: "unknown",
+                    payload: e instanceof Error ? `Unexpected error (${e.message})` : "Unexpected error"
+                };
+            }
+            throw error;
+        }
+        if (response.headers?.get("content-type")?.includes("json")) {
+            return await response.json();
+        } else {
+            return await response.text();
+        }
+    } catch (e) {
+        const errorObject = {
+            name: "unknown",
+            message: e instanceof Error ? `Network error (${e.message})` : "Network error",
+            stack: e
+        };
+        throw errorObject;
+    }
+}
+const resolveUrl = (url, queryParams = {}, pathParams = {})=>{
+    let query = new URLSearchParams(queryParams).toString();
+    if (query) query = `?${query}`;
+    return url.replace(/\{\w*\}/g, (key)=>pathParams[key.slice(1, -1)] ?? "") + query;
+};
+
+/**
+ * @summary Create a Stripe Checkout session for API access
+ * @description Returns a Stripe Checkout URL. After payment, you'll receive an API key.
+ * @link /billing/checkout
+ */ async function createCheckoutBillingCheckoutPost({ config } = {}) {
+    const { client: request = client, ...requestConfig } = config ?? {};
+    const data = await request({
+        method: "POST",
+        url: `/billing/checkout`,
+        ...requestConfig,
+        headers: {
+            ...requestConfig.headers
+        }
+    });
+    return data;
+}
+/**
+ * @summary Check your free-tier usage
+ * @description See how many requests you've used today (free tier, by IP).
+ * @link /billing/usage
+ */ async function checkUsageBillingUsageGet({ config } = {}) {
+    const { client: request = client, ...requestConfig } = config ?? {};
+    const data = await request({
+        method: "GET",
+        url: `/billing/usage`,
+        ...requestConfig,
+        headers: {
+            ...requestConfig.headers
+        }
+    });
+    return data;
+}
+/**
+ * @summary List the full LiteLLM model catalog
+ * @description Returns model pricing, context window sizes, and capability metadata from LiteLLM's built-in catalog. Supports filtering by provider, mode, model name pattern, and pagination.
+ * @link /model_catalog
+ */ async function listModelCatalogModelCatalogGet({ queryParams, config } = {}) {
+    const { client: request = client, ...requestConfig } = config ?? {};
+    const data = await request({
+        method: "GET",
+        url: `/model_catalog`,
+        queryParams,
+        ...requestConfig,
+        headers: {
+            ...requestConfig.headers
+        }
+    });
+    return data;
+}
+/**
+ * @summary Get a single model from the catalog
+ * @description Returns detailed information for a specific model by its exact ID.
+ * @link /model_catalog/{model_id}
+ */ async function getModelCatalogEntryModelCatalogModelIdGet({ pathParams, config } = {}) {
+    const { client: request = client, ...requestConfig } = config ?? {};
+    if (!pathParams.model_id) {
+        throw new Error(`Missing required path parameter: model_id`);
+    }
+    const data = await request({
+        method: "GET",
+        url: `/model_catalog/${pathParams.model_id}`,
+        ...requestConfig,
+        headers: {
+            ...requestConfig.headers
+        }
+    });
+    return data;
+}
+const operationsByPath = {
+    "POST /billing/checkout": createCheckoutBillingCheckoutPost,
+    "GET /billing/usage": checkUsageBillingUsageGet,
+    "GET /model_catalog": listModelCatalogModelCatalogGet,
+    "GET /model_catalog/{model_id}": getModelCatalogEntryModelCatalogModelIdGet
+};
+const operationsByTag = {
+    billing: {
+        createCheckoutBillingCheckoutPost,
+        checkUsageBillingUsageGet
+    }
+};
+const tagDictionary = {
+    billing: {
+        POST: [
+            "createCheckoutBillingCheckoutPost"
+        ],
+        GET: [
+            "checkUsageBillingUsageGet"
+        ]
+    }
+};
+
+exports.checkUsageBillingUsageGet = checkUsageBillingUsageGet;
+exports.client = client;
+exports.createCheckoutBillingCheckoutPost = createCheckoutBillingCheckoutPost;
+exports.getModelCatalogEntryModelCatalogModelIdGet = getModelCatalogEntryModelCatalogModelIdGet;
+exports.listModelCatalogModelCatalogGet = listModelCatalogModelCatalogGet;
+exports.operationsByPath = operationsByPath;
+exports.operationsByTag = operationsByTag;
+exports.tagDictionary = tagDictionary;

package/dist/components.cjs

@@ -0,0 +1,13 @@
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var components = require('./components-g21ikhwl.cjs');
+
+
+
+exports.checkUsageBillingUsageGet = components.checkUsageBillingUsageGet;
+exports.createCheckoutBillingCheckoutPost = components.createCheckoutBillingCheckoutPost;
+exports.getModelCatalogEntryModelCatalogModelIdGet = components.getModelCatalogEntryModelCatalogModelIdGet;
+exports.listModelCatalogModelCatalogGet = components.listModelCatalogModelCatalogGet;
+exports.operationsByPath = components.operationsByPath;
+exports.operationsByTag = components.operationsByTag;
+exports.tagDictionary = components.tagDictionary;

package/dist/components.d.mts

@@ -0,0 +1,115 @@
+import { FreeTierResponse, CheckoutResponse, GetModelCatalogEntryModelCatalogModelIdGetResponse, ListModelCatalogModelCatalogGetResponse } from './types.mjs';
+
+type RequestInit = {
+    body?: string | FormData | URLSearchParams | undefined;
+    headers?: Record<string, string> | undefined;
+    method?: string | undefined;
+    signal?: any | undefined;
+};
+type Response = {
+    ok: boolean;
+    status: number;
+    url: string;
+    json(): Promise<any>;
+    text(): Promise<string>;
+    headers?: {
+        get(name: string): string | null;
+    } | undefined;
+};
+type FetchImpl = (url: string, init?: RequestInit | undefined) => Promise<Response>;
+
+type FetcherConfig = {
+    baseUrl?: string;
+    token?: string | null;
+    fetchImpl?: FetchImpl;
+    headers?: Record<string, any>;
+};
+type FetcherOptions<TBody, THeaders, TQueryParams, TPathParams> = {
+    url: string;
+    method: string;
+    body?: TBody | undefined;
+    headers?: THeaders | undefined;
+    queryParams?: TQueryParams | undefined;
+    pathParams?: TPathParams | undefined;
+    signal?: AbortSignal | undefined;
+} & FetcherConfig;
+declare function client<TData, TError, TBody, THeaders, TQueryParams, TPathParams>({ url, method, body, headers, pathParams, queryParams, signal, baseUrl, token, fetchImpl, }: FetcherOptions<TBody, THeaders, TQueryParams, TPathParams>): Promise<TData>;
+
+/**
+ * @summary Create a Stripe Checkout session for API access
+ * @description Returns a Stripe Checkout URL. After payment, you'll receive an API key.
+ * @link /billing/checkout
+ */
+declare function createCheckoutBillingCheckoutPost({ config }?: {
+    config?: Partial<FetcherConfig> & {
+        client?: typeof client;
+    };
+}): Promise<CheckoutResponse>;
+/**
+ * @summary Check your free-tier usage
+ * @description See how many requests you've used today (free tier, by IP).
+ * @link /billing/usage
+ */
+declare function checkUsageBillingUsageGet({ config }?: {
+    config?: Partial<FetcherConfig> & {
+        client?: typeof client;
+    };
+}): Promise<FreeTierResponse>;
+/**
+ * @summary List the full LiteLLM model catalog
+ * @description Returns model pricing, context window sizes, and capability metadata from LiteLLM's built-in catalog. Supports filtering by provider, mode, model name pattern, and pagination.
+ * @link /model_catalog
+ */
+declare function listModelCatalogModelCatalogGet({ queryParams, config, }?: {
+    queryParams?: {
+        provider?: unknown;
+        mode?: unknown;
+        model?: unknown;
+        supports_vision?: unknown;
+        supports_function_calling?: unknown;
+        supports_reasoning?: unknown;
+        supports_audio_input?: unknown;
+        supports_audio_output?: unknown;
+        supports_prompt_caching?: unknown;
+        supports_response_schema?: unknown;
+        page?: number;
+        page_size?: number;
+    };
+    config?: Partial<FetcherConfig> & {
+        client?: typeof client;
+    };
+}): Promise<ListModelCatalogModelCatalogGetResponse>;
+/**
+ * @summary Get a single model from the catalog
+ * @description Returns detailed information for a specific model by its exact ID.
+ * @link /model_catalog/{model_id}
+ */
+declare function getModelCatalogEntryModelCatalogModelIdGet({ pathParams, config, }?: {
+    pathParams: {
+        model_id: string;
+    };
+    config?: Partial<FetcherConfig> & {
+        client?: typeof client;
+    };
+}): Promise<GetModelCatalogEntryModelCatalogModelIdGetResponse>;
+declare const operationsByPath: {
+    "POST /billing/checkout": typeof createCheckoutBillingCheckoutPost;
+    "GET /billing/usage": typeof checkUsageBillingUsageGet;
+    "GET /model_catalog": typeof listModelCatalogModelCatalogGet;
+    "GET /model_catalog/{model_id}": typeof getModelCatalogEntryModelCatalogModelIdGet;
+};
+declare const operationsByTag: {
+    billing: {
+        createCheckoutBillingCheckoutPost: typeof createCheckoutBillingCheckoutPost;
+        checkUsageBillingUsageGet: typeof checkUsageBillingUsageGet;
+    };
+};
+declare const tagDictionary: {
+    readonly billing: {
+        readonly POST: readonly ["createCheckoutBillingCheckoutPost"];
+        readonly GET: readonly ["checkUsageBillingUsageGet"];
+    };
+};
+
+export { checkUsageBillingUsageGet, createCheckoutBillingCheckoutPost, getModelCatalogEntryModelCatalogModelIdGet, listModelCatalogModelCatalogGet, operationsByPath, operationsByTag, tagDictionary };
+//# sourceMappingURL=components.d.mts.map

package/dist/components.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"components.d.mts","sources":["../src/utils/fetch.ts","../src/utils/fetcher.ts","../src/generated/components.ts"],"mappings":";;AAAA,KAAK,WAAW;AAChB,oBAAoB,QAAQ,GAAG,eAAe;AAC9C,cAAc,MAAM;AACpB;AACA;AACA;AACA,KAAK,QAAQ;AACb;AACA;AACA;AACA,YAAY,OAAO;AACnB,YAAY,OAAO;AACnB;AACA;AACA;AACA;AACA,KAAK,SAAS,wBAAwB,WAAW,iBAAiB,OAAO,CAAC,QAAQ;;ACflF,KAAK,aAAa;AAClB;AACA;AACA,gBAAgB,SAAS;AACzB,cAAc,MAAM;AACpB;AAKA,KAAK,cAAc;AACnB;AACA;AACA;AACA;AACA;AACA;AACA,aAAa,WAAW;AACxB,IAAI,aAAa;AACjB,iBAAiB,MAAM,yJAAyJ,cAAc,+CAA+C,OAAO;;ACZpP;AACA;AACA;AACA;AACA;AACA,iBAAiB,iCAAiC;AAClD,aAAa,OAAO,CAAC,aAAa;AAClC,wBAAwBA,MAAa;AACrC;AACA,IAAI,OAAO,CAACC,gBAAwB;AACpC;AACA;AACA;AACA;AACA;AACA,iBAAiB,yBAAyB;AAC1C,aAAa,OAAO,CAAC,aAAa;AAClC,wBAAwBD,MAAa;AACrC;AACA,IAAI,OAAO,CAACE,gBAAwB;AACpC;AACA;AACA;AACA;AACA;AACA,iBAAiB,+BAA+B;AAChD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,aAAa,OAAO,CAAC,aAAa;AAClC,wBAAwBF,MAAa;AACrC;AACA,IAAI,OAAO,CAAC,uCAAuC;AACnD;AACA;AACA;AACA;AACA;AACA,iBAAiB,0CAA0C;AAC3D;AACA;AACA;AACA,aAAa,OAAO,CAAC,aAAa;AAClC,wBAAwBA,MAAa;AACrC;AACA,IAAI,OAAO,CAAC,kDAAkD;AAC9D,cAAc,gBAAgB;AAC9B,qCAAqC,iCAAiC;AACtE,iCAAiC,yBAAyB;AAC1D,iCAAiC,+BAA+B;AAChE,4CAA4C,0CAA0C;AACtF;AACA,cAAc,eAAe;AAC7B;AACA,kDAAkD,iCAAiC;AACnF,0CAA0C,yBAAyB;AACnE;AACA;AACA,cAAc,aAAa;AAC3B;AACA;AACA;AACA;AACA;;","names":["defaultClient","__types.CheckoutResponse","__types.FreeTierResponse"]}

package/dist/components.mjs

@@ -0,0 +1 @@
+export { b as checkUsageBillingUsageGet, d as createCheckoutBillingCheckoutPost, g as getModelCatalogEntryModelCatalogModelIdGet, l as listModelCatalogModelCatalogGet, a as operationsByPath, o as operationsByTag, t as tagDictionary } from './components-e9x5e8kj.js';