Caido

Install the SDK ​

The Caido Client SDK lets external scripts and tools interact with a Caido instance from outside the application. It handles authentication, GraphQL queries, and REST calls so you can focus on your automation logic.

Requirements

Add the package ​

Install @caido/sdk-client into your project:

bash
pnpm add @caido/sdk-client
bash
npm install @caido/sdk-client
bash
yarn add @caido/sdk-client

Import the client ​

The SDK exposes a Client class as the entry point for every API call. Create an index.ts file and instantiate the client with the URL of your Caido instance:

index.ts ​

ts
import { Client } from "@caido/sdk-client";

const client = new Client({
  url: "http://localhost:8080",
});

If your TypeScript or runtime resolves the import without errors, the SDK is installed correctly.

Continue to Base Setup to configure authentication and make your first call.