Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@momentic/js* API.
npm install @momentic/jsDeveloper-friendly & type-safe Typescript SDK specifically catered to leverage @momentic/js API.
Momentic API: The Momentic REST API. Please see https://docs.momentic.ai for more details.
* SDK Installation
* Requirements
* SDK Example Usage
* Available Resources and Operations
* Standalone functions
* Retries
* Error Handling
* Server Selection
* Custom HTTP Client
* Authentication
* Debugging
The SDK can be installed with either npm, pnpm, bun or yarn package managers.
``bash`
npm add
`bash`
pnpm add
`bash`
bun add
`bash
yarn add
> [!NOTE]
> This package is published with CommonJS and ES Modules (ESM) support.
Requirements
For supported JavaScript runtimes, please consult RUNTIMES.md.
SDK Example Usage
$3
`typescript
import { Momentic } from "@momentic/js";const momentic = new Momentic({
apiKey: process.env["MOMENTIC_API_KEY"] ?? "",
});
async function run() {
const result = await momentic.runs.getStatuses();
// Handle the result
console.log(result);
}
run();
`
Available Resources and Operations
Available methods
$3
* getStatuses - Get run statuses
* get - Get run statuses
$3
* queue - Queue steps run
Standalone functions
All the methods listed above are available as standalone functions. These
functions are ideal for use in applications running in the browser, serverless
runtimes or other environments where application bundle size is a primary
concern. When using a bundler to build your application, all unused
functionality will be either excluded from the final bundle or tree-shaken away.
To read more about standalone functions, check FUNCTIONS.md.
Available standalone functions
runsGet - Get run statuses
- runsGetStatuses - Get run statuses
- stepsQueue - Queue steps run
Retries
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
`typescript
import { Momentic } from "@momentic/js";const momentic = new Momentic({
apiKey: process.env["MOMENTIC_API_KEY"] ?? "",
});
async function run() {
const result = await momentic.runs.getStatuses({
retries: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
});
// Handle the result
console.log(result);
}
run();
`If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
`typescript
import { Momentic } from "@momentic/js";const momentic = new Momentic({
retryConfig: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
apiKey: process.env["MOMENTIC_API_KEY"] ?? "",
});
async function run() {
const result = await momentic.runs.getStatuses();
// Handle the result
console.log(result);
}
run();
`
Error Handling
All SDK methods return a response object or throw an error. By default, an API error will throw a
errors.SDKError.If a HTTP request fails, an operation my also throw an error from the
models/errors/httpclienterrors.ts module:| HTTP Client Error | Description |
| ---------------------------------------------------- | ---------------------------------------------------- |
| RequestAbortedError | HTTP request was aborted by the client |
| RequestTimeoutError | HTTP request timed out due to an AbortSignal signal |
| ConnectionError | HTTP client was unable to make a request to a server |
| InvalidRequestError | Any input used to create a request is invalid |
| UnexpectedClientError | Unrecognised or unexpected error |
In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective Errors tables in SDK docs for more details on possible error types for each operation. For example, the
getStatuses method may throw the following errors:| Error Type | Status Code | Content Type |
| --------------- | ----------- | ------------ |
| errors.SDKError | 4XX, 5XX | \/\ |
`typescript
import { Momentic } from "@momentic/js";
import { SDKValidationError } from "@momentic/js/models/errors";const momentic = new Momentic({
apiKey: process.env["MOMENTIC_API_KEY"] ?? "",
});
async function run() {
let result;
try {
result = await momentic.runs.getStatuses();
// Handle the result
console.log(result);
} catch (err) {
switch (true) {
case (err instanceof SDKValidationError): {
// Validation errors can be pretty-printed
console.error(err.pretty());
// Raw value may also be inspected
console.error(err.rawValue);
return;
}
default: {
throw err;
}
}
}
}
run();
`Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The
SDKValidationError that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue. Additionally, a pretty() method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.
Server Selection
$3
You can override the default server globally by passing a server index to the
serverIdx: number optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:| # | Server |
| --- | --------------------------------- |
| 0 |
https://api.momentic.ai |
| 1 | https://api.staging.momentic.ai |#### Example
`typescript
import { Momentic } from "@momentic/js";const momentic = new Momentic({
serverIdx: 1,
apiKey: process.env["MOMENTIC_API_KEY"] ?? "",
});
async function run() {
const result = await momentic.runs.getStatuses();
// Handle the result
console.log(result);
}
run();
`$3
The default server can also be overridden globally by passing a URL to the
serverURL: string optional parameter when initializing the SDK client instance. For example:
`typescript
import { Momentic } from "@momentic/js";const momentic = new Momentic({
serverURL: "https://api.momentic.ai",
apiKey: process.env["MOMENTIC_API_KEY"] ?? "",
});
async function run() {
const result = await momentic.runs.getStatuses();
// Handle the result
console.log(result);
}
run();
`
Custom HTTP Client
The TypeScript SDK makes API calls using an
HTTPClient that wraps the native
Fetch API. This
client is a thin wrapper around fetch and provides the ability to attach hooks
around the request lifecycle that can be used to modify the request or handle
errors and response.The
HTTPClient constructor takes an optional fetcher argument that can be
used to integrate a third-party HTTP client or when writing tests to mock out
the HTTP client and feed in fixtures.The following example shows how to use the
"beforeRequest" hook to to add a
custom header and a timeout to requests and how to use the "requestError" hook
to log errors:`typescript
import { Momentic } from "@momentic/js";
import { HTTPClient } from "@momentic/js/lib/http";const httpClient = new HTTPClient({
// fetcher takes a function that has the same signature as native
fetch.
fetcher: (request) => {
return fetch(request);
}
});httpClient.addHook("beforeRequest", (request) => {
const nextRequest = new Request(request, {
signal: request.signal || AbortSignal.timeout(5000)
});
nextRequest.headers.set("x-custom-header", "custom value");
return nextRequest;
});
httpClient.addHook("requestError", (error, request) => {
console.group("Request Error");
console.log("Reason:",
${error});
console.log("Endpoint:", ${request.method} ${request.url});
console.groupEnd();
});const sdk = new Momentic({ httpClient });
`
Authentication
$3
This SDK supports the following security scheme globally:
| Name | Type | Scheme | Environment Variable |
| -------- | ---- | ----------- | -------------------- |
|
apiKey | http | HTTP Bearer | MOMENTIC_API_KEY |To authenticate with the API the
apiKey parameter must be set when initializing the SDK client instance. For example:
`typescript
import { Momentic } from "@momentic/js";const momentic = new Momentic({
apiKey: process.env["MOMENTIC_API_KEY"] ?? "",
});
async function run() {
const result = await momentic.runs.getStatuses();
// Handle the result
console.log(result);
}
run();
`
Debugging
You can setup your SDK to emit debug logs for SDK requests and responses.
You can pass a logger that matches
console's interface as an SDK option.> [!WARNING]
> Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
`typescript
import { Momentic } from "@momentic/js";const sdk = new Momentic({ debugLogger: console });
`You can also enable a default debug logger by setting an environment variable
MOMENTIC_DEBUG` to true.This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
looking for the latest version.
While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation.
We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.