@linkage-open/sdk

Developer-friendly & type-safe Typescript SDK specifically catered to leverage @linkage-open/sdk API.

[!IMPORTANT] This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.

Summary

Linkage API: This file has been autogenerated, check out the docs to see how to customize these options

Table of Contents

• @linkage-open/sdk
  • SDK Installation
  • Requirements
  • SDK Example Usage
  • Available Resources and Operations
  • Standalone functions
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Debugging
• Development
  • Maturity
  • Contributions

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add @linkage-open/sdk

PNPM

pnpm add @linkage-open/sdk

Bun

bun add @linkage-open/sdk

Yarn

yarn add @linkage-open/sdk

[!NOTE] This package is published with CommonJS and ES Modules (ESM) support.

Model Context Protocol (MCP) Server

This SDK is also an installable MCP server where the various SDK methods are exposed as tools that can be invoked by AI applications.

Node.js v20 or greater is required to run the MCP server from npm.

Add the following server definition to your claude_desktop_config.json file:

{
  "mcpServers": {
    "Linkage": {
      "command": "npx",
      "args": [
        "-y", "--package", "@linkage-open/sdk",
        "--",
        "mcp", "start"
      ]
    }
  }
}

Create a .cursor/mcp.json file in your project root with the following content:

{
  "mcpServers": {
    "Linkage": {
      "command": "npx",
      "args": [
        "-y", "--package", "@linkage-open/sdk",
        "--",
        "mcp", "start"
      ]
    }
  }
}

You can also run MCP servers as a standalone binary with no additional dependencies. You must pull these binaries from available Github releases:

curl -L -o mcp-server \
    https://github.com/{org}/{repo}/releases/download/{tag}/mcp-server-bun-darwin-arm64 && \
chmod +x mcp-server

If the repo is a private repo you must add your Github PAT to download a release -H "Authorization: Bearer {GITHUB_PAT}".

{
  "mcpServers": {
    "Todos": {
      "command": "./DOWNLOAD/PATH/mcp-server",
      "args": [
        "start"
      ]
    }
  }
}

For a full list of server arguments, run:

npx -y --package @linkage-open/sdk -- mcp start --help

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { Linkage } from "@linkage-open/sdk";

const linkage = new Linkage();

async function run() {
  const result = await linkage.workflows.create();

  console.log(result);
}

run();

Available Resources and Operations

Features

• get - Get project features

ManualTrigger

• execute - Execute a manual trigger

NodeOverlays

• get - Get node overlays

NodeTypes

• get - Get node types

Runs

• list - List workflow runs
• create - Create a workflow run
• get - Get a workflow run
• getEvents - List or stream run events
• ingestEvents - Ingest run events

State

• options - Preflight workflow state requests
• get - Get workflow state
• update - Update workflow state

Trigger

• execute - Execute a webhook trigger
• getDetails - Get trigger details

Workflow

• execute - Execute a workflow run

Workflows

• create - Create a workflow

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.

• featuresGet - Get project features
• manualTriggerExecute - Execute a manual trigger
• nodeOverlaysGet - Get node overlays
• nodeTypesGet - Get node types
• runsCreate - Create a workflow run
• runsGet - Get a workflow run
• runsGetEvents - List or stream run events
• runsIngestEvents - Ingest run events
• runsList - List workflow runs
• stateGet - Get workflow state
• stateOptions - Preflight workflow state requests
• stateUpdate - Update workflow state
• triggerExecute - Execute a webhook trigger
• triggerGetDetails - Get trigger details
• workflowExecute - Execute a workflow run
• workflowsCreate - Create a workflow

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:

import { Linkage } from "@linkage-open/sdk";

const linkage = new Linkage();

async function run() {
  const result = await linkage.workflows.create({
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  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:

import { Linkage } from "@linkage-open/sdk";

const linkage = new Linkage({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
});

async function run() {
  const result = await linkage.workflows.create();

  console.log(result);
}

run();

Error Handling

LinkageError is the base class for all HTTP error responses. It has the following properties:

| Property | Type | Description | | ------------------- | ---------- | --------------------------------------------------------------------------------------- | | error.message | string | Error message | | error.statusCode | number | HTTP response status code eg 404 | | error.headers | Headers | HTTP response headers | | error.body | string | HTTP body. Can be empty string if no body is returned. | | error.rawResponse | Response | Raw HTTP response | | error.data$ | | Optional. Some errors may contain structured data. See Error Classes. |

Example

import { Linkage } from "@linkage-open/sdk";
import * as errors from "@linkage-open/sdk/models/errors";

const linkage = new Linkage();

async function run() {
  try {
    const result = await linkage.workflows.create();

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.LinkageError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.PostApiV1CreateBadRequestError) {
        console.log(error.data$.error); // operations.PostApiV1CreateBadRequestError
      }
    }
  }
}

run();

Error Classes

Primary error:

• LinkageError: The base class for HTTP error responses.

Network errors:

• ConnectionError: HTTP client was unable to make a request to a server.
• RequestTimeoutError: HTTP request timed out due to an AbortSignal signal.
• RequestAbortedError: HTTP request was aborted by the client.
• InvalidRequestError: Any input used to create a request is invalid.
• UnexpectedClientError: Unrecognised or unexpected error.

Inherit from LinkageError:

• GetApiV1FeaturesUnauthorizedError: HTTP 401 response. Status code 401. Applicable to 2 of 16 methods.*
• ForbiddenError: HTTP 403 response. Status code 403. Applicable to 2 of 16 methods.*
• GetApiV1StateNotFoundError: HTTP 404 response. Status code 404. Applicable to 2 of 16 methods.*
• PostApiV1TriggerTriggerIdNotFoundError: HTTP 404 response. Status code 404. Applicable to 2 of 16 methods.*
• GetApiV1FeaturesInternalServerError: HTTP 500 response. Status code 500. Applicable to 2 of 16 methods.*
• PostApiV1TriggerTriggerIdInternalServerError: Validates the webhook trigger and starts a workflow execution. Status code 500. Applicable to 2 of 16 methods.*
• PostApiV1CreateBadRequestError: HTTP 400 response. Status code 400. Applicable to 1 of 16 methods.*
• GetApiV1RunsBadRequestError: HTTP 400 response. Status code 400. Applicable to 1 of 16 methods.*
• PostApiV1RunsBadRequestError: HTTP 400 response. Status code 400. Applicable to 1 of 16 methods.*
• GetApiV1RunsRunIdEventsBadRequestError: HTTP 400 response. Status code 400. Applicable to 1 of 16 methods.*
• PostApiV1RunsRunIdEventsBadRequestError: HTTP 400 response. Status code 400. Applicable to 1 of 16 methods.*
• GetApiV1StateBadRequestError: HTTP 400 response. Status code 400. Applicable to 1 of 16 methods.*
• PostApiV1StateBadRequestError: HTTP 400 response. Status code 400. Applicable to 1 of 16 methods.*
• PostApiV1TriggerTriggerIdBadRequestError: HTTP 400 response. Status code 400. Applicable to 1 of 16 methods.*
• GetApiV1TriggerTriggerIdBadRequestError: HTTP 400 response. Status code 400. Applicable to 1 of 16 methods.*
• PostApiV1TriggerManualBadRequestError: HTTP 400 response. Status code 400. Applicable to 1 of 16 methods.*
• PostApiV1XUnauthorizedError: HTTP 401 response. Status code 401. Applicable to 1 of 16 methods.*
• PostApiV1TriggerTriggerIdUnauthorizedError: HTTP 401 response. Status code 401. Applicable to 1 of 16 methods.*
• PostApiV1TriggerManualUnauthorizedError: HTTP 401 response. Status code 401. Applicable to 1 of 16 methods.*
• PostApiV1CreateNotFoundError: HTTP 404 response. Status code 404. Applicable to 1 of 16 methods.*
• GetApiV1NodeTypesNotFoundError: HTTP 404 response. Status code 404. Applicable to 1 of 16 methods.*
• GetApiV1TriggerTriggerIdNotFoundError: HTTP 404 response. Status code 404. Applicable to 1 of 16 methods.*
• TooManyRequestsError: HTTP 429 response. Status code 429. Applicable to 1 of 16 methods.*
• PostApiV1CreateInternalServerError: HTTP 500 response. Status code 500. Applicable to 1 of 16 methods.*
• PostApiV1RunsInternalServerError: HTTP 500 response. Status code 500. Applicable to 1 of 16 methods.*
• PostApiV1XInternalServerError: HTTP 500 response. Status code 500. Applicable to 1 of 16 methods.*
• ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

* Check the method documentation to see if the error is applicable.

Server Selection

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { Linkage } from "@linkage-open/sdk";

const linkage = new Linkage({
  serverURL: "http://localhost:3000",
});

async function run() {
  const result = await linkage.workflows.create();

  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:

import { Linkage } from "@linkage-open/sdk";
import { HTTPClient } from "@linkage-open/sdk/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 Linkage({ httpClient: httpClient });

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.

import { Linkage } from "@linkage-open/sdk";

const sdk = new Linkage({ debugLogger: console });

You can also enable a default debug logger by setting an environment variable LINKAGE_DEBUG to true.

Development

Maturity

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.

Contributions

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.

SDK Created by Speakeasy