Skip to main content
The npm package is @pureframeai/sdk. It is generated from the public API specification and includes TypeScript request and response types. It requires Node.js 18 or later.

Usage

The client’s exported class is PureframeClient. Note the lowercase “f”, which matches the npm package name (@pureframeai/sdk), not the product’s display capitalization. We recommend reading your API key from an environment variable:

Resources on the client

The client is organized into resources matching the REST API: client.collections, client.upload, client.search, client.videos, client.jobs, client.webhooks, client.apiKeys, client.agent, client.frameMap.

Full reference

See the API reference for available endpoints, parameters, and response types.