Client SDK

A TypeScript library for browser uploads, for when end users submit files from your web or mobile app.

Available on request

The client SDK is not published publicly yet. Contact us for access, or integrate today with the REST API or no-code options in the dashboard.

The client SDK handles browser uploads without exposing your API key: your backend stays in control of authentication. The sections below describe its scope at a high level. Exact names and signatures come with the package.

Installation

A TypeScript package with type definitions included. The browser build has no server dependencies, so it fits a React, Vue, or plain JavaScript front end without a bundler plugin.

Initialization

The SDK never holds your API key. Your backend authorizes an upload, and the SDK sends the file with that authorization, so the key stays server-side. See Authentication for how keys work today, and Concepts for how an application scopes what a key can reach.

What it covers

The upload path an end user goes through, wrapping the same operations documented under API Reference:

Submitting a file for verification, with upload progress while it transfers.
Waiting for the verdict, including the case where analysis takes longer than the wait window and the job has to be polled.
Reading the finished verdict: the assessment, the confidence level, and the per-dimension breakdown.
Cancelling an upload that is still in flight, so a user who navigates away does not leave a request running.

Errors

Failures arrive as typed errors carrying the same codes the REST API returns, so your interface can branch on a code instead of matching text. A file the API will not accept fails as unsupported_format or file_too_large before it costs an upload, and rate_limited is distinguishable from a genuine failure so you can retry rather than show an error. Every code is listed under Error codes.