Authentication & Client - Semple Developer Docs

The Semple class is your primary entry point into the SDK. It handles authentication and provides scoped access to the ModuleBuilder for performing data operations.

Initialization

The Semple client constructor accepts a single string argument: your Secret API Key.

import { Semple, SempleError } from '@trize/semple';

// Initialize with a Secret API Key
const semple = new Semple("smpl_sk_your_api_key_here");

string

required

Your Semple Secret API Key. This must start with smpl_sk_.

Accessing Modules

Because Semple isolates records into distinct Modules, you must scope your operations to a specific module before executing them.

// Create a ModuleBuilder scoped to the specific Module ID
const leadsModule = semple.module("mod_a1b2c3d4e5");

string

required

The exact string ID of the module (e.g., mod_abc123). Note that the SDK requires the moduleId, not the human-readable module name.

Error Handling

The SDK exposes a native SempleError class that maps back to standard API error codes. It is best practice to wrap your mutations in a try/catch block.

import { SempleError } from '@trize/semple';

try {
  await leadsModule.insert({ "Name": "John" });
} catch (error) {
  if (error instanceof SempleError) {
    console.error(`API Error [${error.code}]: ${error.message}`);
    console.error("Details:", error.details);
  } else {
    console.error("An unexpected error occurred", error);
  }
}

string

A machine-readable API error code (e.g., invalid_argument, unauthenticated, not_found).

string

A human-readable explanation of the error.

array

Optional array of detailed violation objects returned by the server.

​Initialization

​Accessing Modules

​Error Handling

Initialization

Accessing Modules

Error Handling