Documentation

SDK Installation

The Get Pronto SDK provides a simple interface for interacting with the Get Pronto API from TypeScript and JavaScript applications.

Installation

Install the SDK using your preferred package manager:

Using npm

bash
npm install getpronto-sdk

Using yarn

bash
yarn add getpronto-sdk

Using pnpm

bash
pnpm add getpronto-sdk

Basic Usage

After installation, initialize the client with your API key. The SDK automatically detects the key type from the prefix.

Server-side (Secret Key)

Full access — upload, list, get, delete, and transform images.

typescript
import GetProntoClient from "getpronto-sdk";

// Server-side — full access (Node.js, API routes, server components)
const client = new GetProntoClient({
  apiKey: "pronto_sk_..."
});

Client-side (Public Key)

Upload only — safe to use in browser code.

typescript
import GetProntoClient from "getpronto-sdk";

// Client-side — upload only (safe for browser code)
const client = new GetProntoClient({
  apiKey: "pronto_pk_..."
});

Learn more about key types and permissions in our Authentication guide.

Configuration Options

The SDK client accepts the following configuration options:

OptionTypeRequiredDescription
apiKeystringYesYour Get Pronto API key for authentication
baseUrlstringNoCustom API base URL (defaults to https://api.getpronto.io/v1)
timeoutnumberNoRequest timeout in milliseconds
retriesnumberNoNumber of retries for failed requests
headersRecord<string, string>NoAdditional headers to include in all requests

Advanced Configuration

Example with custom configuration options:

typescript
import GetProntoClient from "getpronto-sdk";

// Initialize with additional options
const client = new GetProntoClient({
  apiKey: "pronto_sk_...",
  baseUrl: "https://api.your-domain.com/v1",
  headers: {
    "User-Agent": "MyApp/1.0.0"
  }
});

TypeScript Support

The SDK is written in TypeScript and includes type definitions. Type hints and autocompletion will work out of the box in TypeScript projects and IDEs that support TypeScript.

You can import types from the SDK for use in your application:

typescript
import { 
  ClientConfig,
  FileMetadata,
  TransformOptions,
} from "getpronto-sdk";

Next Steps

Continue exploring our documentation with these related topics: