@mixedbread/sdk 0.5.0 → 0.7.2

package/resources/vector-stores/vector-stores.mjs

@@ -21,31 +21,32 @@ export class VectorStores extends APIResource {
         return this._client.post('/v1/vector_stores', { body, ...options });
     }
     /**
-     * Get a vector store by ID.
+     * Get a vector store by ID or name.
      *
-     * Args: vector_store_id: The ID of the vector store to retrieve.
+     * Args: vector_store_identifier: The ID or name of the vector store to retrieve.
      *
      * Returns: VectorStore: The response containing the vector store details.
      */
-    retrieve(vectorStoreID, options) {
-        return this._client.get(path `/v1/vector_stores/${vectorStoreID}`, options);
+    retrieve(vectorStoreIdentifier, options) {
+        return this._client.get(path `/v1/vector_stores/${vectorStoreIdentifier}`, options);
     }
     /**
-     * Update a vector store by ID.
+     * Update a vector store by ID or name.
      *
-     * Args: vector_store_id: The ID of the vector store to update.
+     * Args: vector_store_identifier: The ID or name of the vector store to update.
      * vector_store_update: VectorStoreCreate object containing the name, description,
      * and metadata.
      *
      * Returns: VectorStore: The response containing the updated vector store details.
      */
-    update(vectorStoreID, body, options) {
-        return this._client.put(path `/v1/vector_stores/${vectorStoreID}`, { body, ...options });
+    update(vectorStoreIdentifier, body, options) {
+        return this._client.put(path `/v1/vector_stores/${vectorStoreIdentifier}`, { body, ...options });
     }
     /**
-     * List all vector stores.
+     * List all vector stores with optional search.
      *
-     * Args: pagination: The pagination options.
+     * Args: pagination: The pagination options. q: Optional search query to filter
+     * vector stores.
      *
      * Returns: VectorStoreListResponse: The list of vector stores.
      */
@@ -53,14 +54,14 @@ export class VectorStores extends APIResource {
         return this._client.getAPIList('/v1/vector_stores', (LimitOffset), { query, ...options });
     }
     /**
-     * Delete a vector store by ID.
+     * Delete a vector store by ID or name.
      *
-     * Args: vector_store_id: The ID of the vector store to delete.
+     * Args: vector_store_identifier: The ID or name of the vector store to delete.
      *
      * Returns: VectorStore: The response containing the deleted vector store details.
      */
-    delete(vectorStoreID, options) {
-        return this._client.delete(path `/v1/vector_stores/${vectorStoreID}`, options);
+    delete(vectorStoreIdentifier, options) {
+        return this._client.delete(path `/v1/vector_stores/${vectorStoreIdentifier}`, options);
     }
     /**
      * Question answering
@@ -76,7 +77,9 @@ export class VectorStores extends APIResource {
      * relevance-scored results.
      *
      * Args: search_params: Search configuration including: - query text or
-     * embeddings - metadata filters - pagination parameters - sorting preferences
+     * embeddings - vector_store_ids: List of vector stores to search - file_ids:
+     * Optional list of file IDs to filter chunks by (or tuple of list and condition
+     * operator) - metadata filters - pagination parameters - sorting preferences
      * \_state: API state dependency \_ctx: Service context dependency
      *
      * Returns: VectorStoreSearchChunkResponse containing: - List of matched chunks

package/resources/vector-stores/vector-stores.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"vector-stores.mjs","sourceRoot":"","sources":["../../src/resources/vector-stores/vector-stores.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,KAAK,QAAQ;OACb,EAQL,KAAK,GAIN;OAEM,EAAE,WAAW,EAAuC;OAEpD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,YAAa,SAAQ,WAAW;IAA7C;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAiG3D,CAAC;IA/FC;;;;;;;OAOG;IACH,MAAM,CAAC,IAA6B,EAAE,OAAwB;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,aAAqB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,aAAa,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CACJ,aAAqB,EACrB,IAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,aAAa,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;OAMG;IACH,IAAI,CACF,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,CAAA,WAAwB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,aAAqB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,qBAAqB,aAAa,EAAE,EAAE,OAAO,CAAC,CAAC;IAChF,CAAC;IAED;;OAEG;IACH,iBAAiB,CACf,IAAwC,EACxC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sCAAsC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAA6B,EAAE,OAAwB;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;CACF;AA8bD,YAAY,CAAC,KAAK,GAAG,KAAK,CAAC"}
+{"version":3,"file":"vector-stores.mjs","sourceRoot":"","sources":["../../src/resources/vector-stores/vector-stores.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,KAAK,QAAQ;OACb,EAQL,KAAK,GAIN;OAEM,EAAE,WAAW,EAAuC;OAEpD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,YAAa,SAAQ,WAAW;IAA7C;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAoG3D,CAAC;IAlGC;;;;;;;OAOG;IACH,MAAM,CAAC,IAA6B,EAAE,OAAwB;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,qBAA6B,EAAE,OAAwB;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,qBAAqB,EAAE,EAAE,OAAO,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CACJ,qBAA6B,EAC7B,IAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,qBAAqB,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClG,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CACF,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,CAAA,WAAwB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,qBAA6B,EAAE,OAAwB;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,qBAAqB,qBAAqB,EAAE,EAAE,OAAO,CAAC,CAAC;IACxF,CAAC;IAED;;OAEG;IACH,iBAAiB,CACf,IAAwC,EACxC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sCAAsC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CAAC,IAA6B,EAAE,OAAwB;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;CACF;AA8pBD,YAAY,CAAC,KAAK,GAAG,KAAK,CAAC"}

package/src/client.ts

@@ -32,7 +32,16 @@ import { APIPromise } from './core/api-promise';
 import { type Fetch } from './internal/builtin-types';
 import { HeadersLike, NullableHeaders, buildHeaders } from './internal/headers';
 import { FinalRequestOptions, RequestOptions } from './internal/request-options';
-import { EmbeddingCreateParams, Embeddings } from './resources/embeddings';
+import {
+  APIKey,
+  APIKeyCreateParams,
+  APIKeyCreated,
+  APIKeyDeleteResponse,
+  APIKeyListParams,
+  APIKeys,
+  APIKeysLimitOffset,
+} from './resources/api-keys';
+import { EmbeddingCreateParams, Embeddings, EncodingFormat, ObjectType } from './resources/embeddings';
 import {
   FileCreateParams,
   FileDeleteResponse,
@@ -41,21 +50,34 @@ import {
   FileObjectsLimitOffset,
   FileUpdateParams,
   Files,
+  PaginationWithTotal,
 } from './resources/files';
 import { readEnv } from './internal/utils/env';
 import { formatRequestDetails, loggerFor } from './internal/utils/log';
 import { isEmptyObj } from './internal/utils/values';
+import {
+  DataSource,
+  DataSourceCreateParams,
+  DataSourceDeleteResponse,
+  DataSourceListParams,
+  DataSourceOauth2Params,
+  DataSourceType,
+  DataSourceUpdateParams,
+  DataSources,
+  DataSourcesLimitOffset,
+} from './resources/data-sources/data-sources';
 import { Extractions } from './resources/extractions/extractions';
 import { Parsing } from './resources/parsing/parsing';
 import {
   ExpiresAfter,
-  FileCounts,
-  ScoredVectorStoreChunk,
+  ScoredAudioURLInputChunk,
+  ScoredImageURLInputChunk,
+  ScoredTextInputChunk,
+  ScoredVideoURLInputChunk,
   VectorStore,
   VectorStoreChunkSearchOptions,
   VectorStoreCreateParams,
   VectorStoreDeleteResponse,
-  VectorStoreFileSearchOptions,
   VectorStoreListParams,
   VectorStoreQuestionAnsweringParams,
   VectorStoreQuestionAnsweringResponse,
@@ -254,14 +276,6 @@ export class Mixedbread {
    * Args: params: The parameters for creating embeddings.
    *
    * Returns: EmbeddingCreateResponse: The response containing the embeddings.
-   *
-   * @example
-   * ```ts
-   * const embeddingCreateResponse = await client.embed({
-   *   model: 'mixedbread-ai/mxbai-embed-large-v1',
-   *   input: 'x',
-   * });
-   * ```
    */
   embed(
     body: TopLevelAPI.EmbedParams,
@@ -274,11 +288,6 @@ export class Mixedbread {
    * Returns service information, including name and version.
    *
    * Returns: InfoResponse: A response containing the service name and version.
-   *
-   * @example
-   * ```ts
-   * const response = await client.info();
-   * ```
    */
   info(options?: RequestOptions): APIPromise<TopLevelAPI.InfoResponse> {
     return this.get('/', options);
@@ -290,15 +299,6 @@ export class Mixedbread {
    * Args: params: RerankParams: The parameters for reranking.
    *
    * Returns: RerankResponse: The reranked documents for the input query.
-   *
-   * @example
-   * ```ts
-   * const response = await client.rerank({
-   *   query:
-   *     'What are the key features of the Mixedbread embedding model?',
-   *   input: ['Document 1', 'Document 2'],
-   * });
-   * ```
    */
   rerank(body: TopLevelAPI.RerankParams, options?: RequestOptions): APIPromise<TopLevelAPI.RerankResponse> {
     return this.post('/v1/reranking', { body, ...options });
@@ -837,12 +837,16 @@ export class Mixedbread {
   files: API.Files = new API.Files(this);
   extractions: API.Extractions = new API.Extractions(this);
   embeddings: API.Embeddings = new API.Embeddings(this);
+  dataSources: API.DataSources = new API.DataSources(this);
+  apiKeys: API.APIKeys = new API.APIKeys(this);
 }
 Mixedbread.VectorStores = VectorStores;
 Mixedbread.Parsing = Parsing;
 Mixedbread.Files = Files;
 Mixedbread.Extractions = Extractions;
 Mixedbread.Embeddings = Embeddings;
+Mixedbread.DataSources = DataSources;
+Mixedbread.APIKeys = APIKeys;
 export declare namespace Mixedbread {
   export type RequestOptions = Opts.RequestOptions;
 
@@ -862,11 +866,12 @@ export declare namespace Mixedbread {
   export {
     VectorStores as VectorStores,
     type ExpiresAfter as ExpiresAfter,
-    type FileCounts as FileCounts,
-    type ScoredVectorStoreChunk as ScoredVectorStoreChunk,
+    type ScoredAudioURLInputChunk as ScoredAudioURLInputChunk,
+    type ScoredImageURLInputChunk as ScoredImageURLInputChunk,
+    type ScoredTextInputChunk as ScoredTextInputChunk,
+    type ScoredVideoURLInputChunk as ScoredVideoURLInputChunk,
     type VectorStore as VectorStore,
     type VectorStoreChunkSearchOptions as VectorStoreChunkSearchOptions,
-    type VectorStoreFileSearchOptions as VectorStoreFileSearchOptions,
     type VectorStoreDeleteResponse as VectorStoreDeleteResponse,
     type VectorStoreQuestionAnsweringResponse as VectorStoreQuestionAnsweringResponse,
     type VectorStoreSearchResponse as VectorStoreSearchResponse,
@@ -883,6 +888,7 @@ export declare namespace Mixedbread {
   export {
     Files as Files,
     type FileObject as FileObject,
+    type PaginationWithTotal as PaginationWithTotal,
     type FileDeleteResponse as FileDeleteResponse,
     type FileObjectsLimitOffset as FileObjectsLimitOffset,
     type FileCreateParams as FileCreateParams,
@@ -892,7 +898,34 @@ export declare namespace Mixedbread {
 
   export { Extractions as Extractions };
 
-  export { Embeddings as Embeddings, type EmbeddingCreateParams as EmbeddingCreateParams };
+  export {
+    Embeddings as Embeddings,
+    type EncodingFormat as EncodingFormat,
+    type ObjectType as ObjectType,
+    type EmbeddingCreateParams as EmbeddingCreateParams,
+  };
+
+  export {
+    DataSources as DataSources,
+    type DataSource as DataSource,
+    type DataSourceOauth2Params as DataSourceOauth2Params,
+    type DataSourceType as DataSourceType,
+    type DataSourceDeleteResponse as DataSourceDeleteResponse,
+    type DataSourcesLimitOffset as DataSourcesLimitOffset,
+    type DataSourceCreateParams as DataSourceCreateParams,
+    type DataSourceUpdateParams as DataSourceUpdateParams,
+    type DataSourceListParams as DataSourceListParams,
+  };
+
+  export {
+    APIKeys as APIKeys,
+    type APIKey as APIKey,
+    type APIKeyCreated as APIKeyCreated,
+    type APIKeyDeleteResponse as APIKeyDeleteResponse,
+    type APIKeysLimitOffset as APIKeysLimitOffset,
+    type APIKeyCreateParams as APIKeyCreateParams,
+    type APIKeyListParams as APIKeyListParams,
+  };
 
   export type SearchFilter = API.SearchFilter;
   export type SearchFilterCondition = API.SearchFilterCondition;

package/src/core/pagination.ts

@@ -99,7 +99,7 @@ export class PagePromise<
    *      console.log(item)
    *    }
    */
-  async *[Symbol.asyncIterator]() {
+  async *[Symbol.asyncIterator](): AsyncGenerator<Item> {
     const page = await this;
     for await (const item of page) {
       yield item;

package/src/core/resource.ts

@@ -2,7 +2,7 @@
 
 import type { Mixedbread } from '../client';
 
-export class APIResource {
+export abstract class APIResource {
   protected _client: Mixedbread;
 
   constructor(client: Mixedbread) {

package/src/internal/detect-platform.ts

@@ -85,10 +85,10 @@ const getPlatformProperties = (): PlatformProperties => {
     return {
       'X-Stainless-Lang': 'js',
       'X-Stainless-Package-Version': VERSION,
-      'X-Stainless-OS': normalizePlatform((globalThis as any).process.platform),
-      'X-Stainless-Arch': normalizeArch((globalThis as any).process.arch),
+      'X-Stainless-OS': normalizePlatform((globalThis as any).process.platform ?? 'unknown'),
+      'X-Stainless-Arch': normalizeArch((globalThis as any).process.arch ?? 'unknown'),
       'X-Stainless-Runtime': 'node',
-      'X-Stainless-Runtime-Version': (globalThis as any).process.version,
+      'X-Stainless-Runtime-Version': (globalThis as any).process.version ?? 'unknown',
     };
   }
 

package/src/internal/headers.ts

@@ -1,5 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+import { isReadonlyArray } from './utils/values';
+
 type HeaderValue = string | undefined | null;
 export type HeadersLike =
   | Headers
@@ -9,7 +11,7 @@ export type HeadersLike =
   | null
   | NullableHeaders;
 
-const brand_privateNullableHeaders = Symbol('brand.privateNullableHeaders');
+const brand_privateNullableHeaders = /* @__PURE__ */ Symbol('brand.privateNullableHeaders');
 
 /**
  * @internal
@@ -25,8 +27,6 @@ export type NullableHeaders = {
   nulls: Set<string>;
 };
 
-const isArray = Array.isArray as (val: unknown) => val is readonly unknown[];
-
 function* iterateHeaders(headers: HeadersLike): IterableIterator<readonly [string, string | null]> {
   if (!headers) return;
 
@@ -43,7 +43,7 @@ function* iterateHeaders(headers: HeadersLike): IterableIterator<readonly [strin
   let iter: Iterable<readonly (HeaderValue | readonly HeaderValue[])[]>;
   if (headers instanceof Headers) {
     iter = headers.entries();
-  } else if (isArray(headers)) {
+  } else if (isReadonlyArray(headers)) {
     iter = headers;
   } else {
     shouldClear = true;
@@ -52,7 +52,7 @@ function* iterateHeaders(headers: HeadersLike): IterableIterator<readonly [strin
   for (let row of iter) {
     const name = row[0];
     if (typeof name !== 'string') throw new TypeError('expected header name to be a string');
-    const values = isArray(row[1]) ? row[1] : [row[1]];
+    const values = isReadonlyArray(row[1]) ? row[1] : [row[1]];
     let didClear = false;
     for (const value of values) {
       if (value === undefined) continue;
@@ -71,8 +71,8 @@ function* iterateHeaders(headers: HeadersLike): IterableIterator<readonly [strin
 export const buildHeaders = (newHeaders: HeadersLike[]): NullableHeaders => {
   const targetHeaders = new Headers();
   const nullHeaders = new Set<string>();
-  const seenHeaders = new Set<string>();
   for (const headers of newHeaders) {
+    const seenHeaders = new Set<string>();
     for (const [name, value] of iterateHeaders(headers)) {
       const lowerName = name.toLowerCase();
       if (!seenHeaders.has(lowerName)) {

package/src/internal/shim-types.ts

@@ -0,0 +1,26 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+/**
+ * Shims for types that we can't always rely on being available globally.
+ *
+ * Note: these only exist at the type-level, there is no corresponding runtime
+ * version for any of these symbols.
+ */
+
+type NeverToAny<T> = T extends never ? any : T;
+
+/** @ts-ignore */
+type _DOMReadableStream<R = any> = globalThis.ReadableStream<R>;
+
+/** @ts-ignore */
+type _NodeReadableStream<R = any> = import('stream/web').ReadableStream<R>;
+
+type _ConditionalNodeReadableStream<R = any> =
+  typeof globalThis extends { ReadableStream: any } ? never : _NodeReadableStream<R>;
+
+type _ReadableStream<R = any> = NeverToAny<
+  | ([0] extends [1 & _DOMReadableStream<R>] ? never : _DOMReadableStream<R>)
+  | ([0] extends [1 & _ConditionalNodeReadableStream<R>] ? never : _ConditionalNodeReadableStream<R>)
+>;
+
+export type { _ReadableStream as ReadableStream };

package/src/internal/shims.ts

@@ -7,8 +7,8 @@
  * messages in cases where an environment isn't fully supported.
  */
 
-import { type Fetch } from './builtin-types';
-import { type ReadableStream } from './shim-types';
+import type { Fetch } from './builtin-types';
+import type { ReadableStream } from './shim-types';
 
 export function getDefaultFetch(): Fetch {
   if (typeof fetch !== 'undefined') {

package/src/internal/uploads.ts

@@ -90,7 +90,7 @@ export const multipartFormRequestOptions = async (
   return { ...opts, body: await createForm(opts.body, fetch) };
 };
 
-const supportsFormDataMap = new WeakMap<Fetch, Promise<boolean>>();
+const supportsFormDataMap = /** @__PURE__ */ new WeakMap<Fetch, Promise<boolean>>();
 
 /**
  * node-fetch doesn't support the global FormData object in recent node versions. Instead of sending
@@ -138,7 +138,7 @@ export const createForm = async <T = Record<string, unknown>>(
 
 // We check for Blob not File because Bun.File doesn't inherit from File,
 // but they both inherit from Blob and have a `name` property at runtime.
-const isNamedBlob = (value: object) => value instanceof Blob && 'name' in value;
+const isNamedBlob = (value: unknown) => value instanceof Blob && 'name' in value;
 
 const isUploadable = (value: unknown) =>
   typeof value === 'object' &&

package/src/internal/utils/log.ts

@@ -58,7 +58,7 @@ const noopLogger = {
   debug: noop,
 };
 
-let cachedLoggers = new WeakMap<Logger, [LogLevel, Logger]>();
+let cachedLoggers = /** @__PURE__ */ new WeakMap<Logger, [LogLevel, Logger]>();
 
 export function loggerFor(client: Mixedbread): Logger {
   const logger = client.logger;

package/src/internal/utils/path.ts

@@ -62,4 +62,4 @@ export const createPathTagFunction = (pathEncoder = encodeURIPath) =>
 /**
  * URI-encodes path params and ensures no unsafe /./ or /../ path segments are introduced.
  */
-export const path = createPathTagFunction(encodeURIPath);
+export const path = /* @__PURE__ */ createPathTagFunction(encodeURIPath);

package/src/internal/utils/values.ts

@@ -9,6 +9,9 @@ export const isAbsoluteURL = (url: string): boolean => {
   return startsWithSchemeRegexp.test(url);
 };
 
+export let isArray = (val: unknown): val is unknown[] => ((isArray = Array.isArray), isArray(val));
+export let isReadonlyArray = isArray as (val: unknown) => val is readonly unknown[];
+
 /** Returns an object if the given value isn't an object, otherwise returns as-is */
 export function maybeObj(x: unknown): object {
   if (typeof x !== 'object') {

package/src/resources/api-keys.ts

@@ -0,0 +1,225 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { LimitOffset, type LimitOffsetParams, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class APIKeys extends APIResource {
+  /**
+   * Create a new API key.
+   *
+   * Args: params: The parameters for creating the API key.
+   *
+   * Returns: ApiKeyCreated: The response containing the details of the created API
+   * key.
+   */
+  create(body: APIKeyCreateParams, options?: RequestOptions): APIPromise<APIKeyCreated> {
+    return this._client.post('/v1/api-keys', { body, ...options });
+  }
+
+  /**
+   * Retrieve details of a specific API key by its ID.
+   *
+   * Args: api_key_id: The ID of the API key to retrieve.
+   *
+   * Returns: ApiKey: The response containing the API key details.
+   */
+  retrieve(apiKeyID: string, options?: RequestOptions): APIPromise<APIKey> {
+    return this._client.get(path`/v1/api-keys/${apiKeyID}`, options);
+  }
+
+  /**
+   * List all API keys for the authenticated user.
+   *
+   * Args: pagination: The pagination options
+   *
+   * Returns: A list of API keys belonging to the user.
+   */
+  list(
+    query: APIKeyListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<APIKeysLimitOffset, APIKey> {
+    return this._client.getAPIList('/v1/api-keys', LimitOffset<APIKey>, { query, ...options });
+  }
+
+  /**
+   * Delete a specific API key by its ID.
+   *
+   * Args: api_key_id: The ID of the API key to delete.
+   *
+   * Returns: ApiKeyDeleted: The response containing the details of the deleted API
+   * key.
+   */
+  delete(apiKeyID: string, options?: RequestOptions): APIPromise<APIKeyDeleteResponse> {
+    return this._client.delete(path`/v1/api-keys/${apiKeyID}`, options);
+  }
+
+  /**
+   * Reroll the secret for a specific API key by its ID.
+   *
+   * This generates a new secret key, invalidating the old one.
+   *
+   * Args: api_key_id: The ID of the API key to reroll.
+   *
+   * Returns: ApiKeyCreated: The response containing the API key details with the new
+   * secret key.
+   */
+  reroll(apiKeyID: string, options?: RequestOptions): APIPromise<APIKeyCreated> {
+    return this._client.post(path`/v1/api-keys/${apiKeyID}/reroll`, options);
+  }
+
+  /**
+   * Revoke a specific API key by its ID.
+   *
+   * Args: api_key_id: The ID of the API key to revoke.
+   *
+   * Returns: ApiKey: The response containing the details of the revoked API key.
+   */
+  revoke(apiKeyID: string, options?: RequestOptions): APIPromise<APIKey> {
+    return this._client.post(path`/v1/api-keys/${apiKeyID}/revoke`, options);
+  }
+}
+
+export type APIKeysLimitOffset = LimitOffset<APIKey>;
+
+/**
+ * Response model for an API key.
+ */
+export interface APIKey {
+  /**
+   * The ID of the API key
+   */
+  id: string;
+
+  /**
+   * The name of the API key
+   */
+  name: string;
+
+  /**
+   * The redacted value of the API key
+   */
+  redacted_value: string;
+
+  /**
+   * The expiration datetime of the API key
+   */
+  expires_at?: string | null;
+
+  /**
+   * The creation datetime of the API key
+   */
+  created_at: string;
+
+  /**
+   * The last update datetime of the API key
+   */
+  updated_at: string;
+
+  /**
+   * The last active datetime of the API key
+   */
+  last_active_at?: string | null;
+
+  /**
+   * The type of the object
+   */
+  object?: 'api_key';
+}
+
+/**
+ * Response model for creating an API key.
+ */
+export interface APIKeyCreated {
+  /**
+   * The ID of the API key
+   */
+  id: string;
+
+  /**
+   * The name of the API key
+   */
+  name: string;
+
+  /**
+   * The redacted value of the API key
+   */
+  redacted_value: string;
+
+  /**
+   * The expiration datetime of the API key
+   */
+  expires_at?: string | null;
+
+  /**
+   * The creation datetime of the API key
+   */
+  created_at: string;
+
+  /**
+   * The last update datetime of the API key
+   */
+  updated_at: string;
+
+  /**
+   * The last active datetime of the API key
+   */
+  last_active_at?: string | null;
+
+  /**
+   * The type of the object
+   */
+  object?: 'api_key';
+
+  /**
+   * The value of the API key
+   */
+  value: string;
+}
+
+/**
+ * Response model for deleting an API key.
+ */
+export interface APIKeyDeleteResponse {
+  /**
+   * The ID of the deleted API key
+   */
+  id: string;
+
+  /**
+   * Whether the API key was deleted
+   */
+  deleted: boolean;
+
+  /**
+   * The type of the object deleted
+   */
+  object?: 'api_key';
+}
+
+export interface APIKeyCreateParams {
+  /**
+   * A name/description for the API key
+   */
+  name?: string;
+
+  /**
+   * Optional expiration datetime
+   */
+  expires_at?: string | null;
+}
+
+export interface APIKeyListParams extends LimitOffsetParams {}
+
+export declare namespace APIKeys {
+  export {
+    type APIKey as APIKey,
+    type APIKeyCreated as APIKeyCreated,
+    type APIKeyDeleteResponse as APIKeyDeleteResponse,
+    type APIKeysLimitOffset as APIKeysLimitOffset,
+    type APIKeyCreateParams as APIKeyCreateParams,
+    type APIKeyListParams as APIKeyListParams,
+  };
+}