scaleapi

Scale Node Library

The Scale Node.js library provides access to the Scale API from JavaScript/TypeScript.

Documentation

API reference documentation is available here.

Installation

npm install scaleapi

or

yarn add scaleapi

Usage

import { ScaleClient } from 'scaleapi';

const scale = new ScaleClient({
  token: 'YOUR_API_KEY',
});

const batch = await scale.batches.create({
  project: 'project-id',
  name: 'My project',
});

console.log('Received response from Scale', response);

Authentication

You can find your API keys on your dashboard, which you can access by logging in or signing up.

When you constuct the ScaleClient, you can pass in your API key.

import { ScaleClient } from 'scaleapi';

const scale = new ScaleClient({
  token: process.env.SCALE_API_KEY,
});

You can also pass a function:

import { ScaleClient } from 'scaleapi';

const scale = new ScaleClient({
  token: getScaleApiKey,
});

function getScaleApiKey() {
  ...
}

IDE integration

The Scale SDK is crafted to give you a great experience in your IDE. All types are nested in the Scale export.

import { ScaleClient, Scale } from 'scaleapi';

const scale = new ScaleClient({
  token: process.env.SCALE_API_KEY,
});

const batch: Scale.Batch = await scale.batches.create({
  project: 'project-id',
  name: 'My project',
});

You'll get autocomplete for methods:

and properties:

The SDK is fully typed. If you're using TypeScript, you'll get compiler errors if misuse the SDK:

Error handling

When an error is encountered, a ScaleError is thrown. The error may contain a message or a response body, which you can log to see additional information.

import { ScaleClient, ScaleError } from 'scaleapi';

const scale = new ScaleClient({
  token: process.env.SCALE_API_KEY,
});

try {
  const batch = await scale.batches.create({
    project: 'project-id',
    name: 'My project',
  });
  ...
} catch (error) {
  if (error instanceof ScaleError) {
    console.error("Failed to create batch", error.message, error.body);
  } else {
    console.error(error);
  }
}

Timeouts

The Scale SDK will timeout after 60 seconds. When this happens, a ScaleTimeoutError is thrown:

import { ScaleClient, ScaleTimeoutError } from 'scaleapi';

const scale = new ScaleClient({
  token: process.env.SCALE_API_KEY,
});

try {
  const batch = await scale.batches.create({
    project: 'project-id',
    name: 'My project',
  });
  ...
} catch (error) {
  if (error instanceof ScaleTimeoutError) {
    console.error("Timed out while trying to create batch.");
  } else {
    console.error(error);
  }
}

Beta status

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning the package version to a specific version in your package.json file. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!

🌿 This SDK was generated by Fern