SDK Overview

@ivybiosciences/sdk is a planned TypeScript client for the platform. It is a specification, not a released package: the pages in this section describe the interface it is planned to have, so you can see how it will wrap job submission, progress, and result downloads in typed methods. Today the only scheduled releases are the @pleach/* packages and the ivybloom CLI. To call the platform today, use the REST API, the ivybloom CLI, or the MCP server. The per-module specifications are linked under Related Docs: the Client, Jobs, Artifacts, real-time updates, React Hooks, Types & Constants, and Errors.

@ivybiosciences/sdk

Planned TypeScript SDK for the IvyAI Computational Biology Platform.

SDK vs REST vs Harness

Status

There is no install command, because nothing is published. Code samples on these pages that import @ivybiosciences/sdk show the planned interface and will not run.

Quick Start (planned interface)

import { createIvyClient } from "@ivybiosciences/sdk"

const ivy = createIvyClient({ apiKey: "ivy_your_key_here" })

const result = await ivy.jobs.submitAndWait({
  toolName: "esmfold",
  parameters: { protein_sequence: "MKFLILLFNILCLFPVLAADNH" },
  analysisLevel: "comprehensive",
})

console.log(result.status)       // "COMPLETED"
console.log(result.result)       // { plddt_mean: 0.87, num_residues: 342 }
console.log(result.presignedUrl) // S3 download URL for the PDB file

Authentication Modes

The SDK always sends a credential. To try the platform without one, use the keyless request in Guest curl.

Package Exports

// Core SDK
import { createIvyClient, IvyClient } from "@ivybiosciences/sdk"

// Domain managers
import { JobManager, ArtifactManager, IvyWebSocket } from "@ivybiosciences/sdk"

// Error classes
import { IvyApiError, IvyTimeoutError, IvyWebSocketError } from "@ivybiosciences/sdk"

// Types
import type { IvyClientConfig, JobProgress, SubmitJobParams } from "@ivybiosciences/sdk"

// Constants
import { JOB_TYPES, DEFAULT_BASE_URL } from "@ivybiosciences/sdk"
import type { JobType } from "@ivybiosciences/sdk"

// React hooks (subpath export)
import { IvyProvider, useIvyClient, useIvyJob, useIvyWebSocket } from "@ivybiosciences/sdk/react"

Architecture

IvyClient
├── jobs: JobManager         — Submit, poll, wait, list, delete
├── artifacts: ArtifactManager — Download presigned S3 URLs
└── websocket: IvyWebSocket  — Real-time progress subscriptions

Supported Tools

See Types & Constants for the complete registry of the computational tools the SDK supports, including:

• Structure Prediction: ESMFold, ESM3
• Molecular Docking: DiffDock, REINVENT
• Property Prediction: ADMET AI, GraphSol, DeepSol, ProTox-3
• Database Screening: RDKit, ZINC, PubChem
• Sequence Analysis: BLAST, AiZynthFinder
• Literature Mining: BioBERT

Related Docs

• Client Reference
• Jobs Reference
• WebSocket Reference
• Guest curl — the keyless first call, no SDK needed
• Artifacts Reference
• React Hooks
• Types & Constants
• Errors Reference
• Integration Examples