Integrations

Workspaces connect to external systems through connections. A connection holds a provider, its credentials, and — for storage providers — a sync schedule. There are two kinds:

Object Storage

s3, azure, gcs — sync files in and out of a workspace

LLM Inference

openai, anthropic, ollama — back AI-driven detection

Creating a Connection

POST /workspaces/{workspaceSlug}/connections/

The body carries a displayName, a typed config, and optionally isActive and a sync schedule. The provider is inferred from the config.

const connection = await client.connections.createConnection(workspaceSlug, {
  displayName: "Archive bucket",
  config: {
    provider: "s3",
    credentials: { /* provider credentials */ },
    rootPath: "contracts/",
  },
});

const connection = await client.connections.createConnection(workspaceSlug, {
  displayName: "Detection model",
  config: {
    provider: "anthropic",
    credentials: { /* api key */ },
    defaultModel: "claude-sonnet-5",
  },
});

const connection = await client.connections.createConnection(workspaceSlug, {
  displayName: "Local inference",
  config: {
    provider: "ollama",
    baseUrl: "http://127.0.0.1:11434",
    defaultModel: "llama3",
  },
});

ollama requires baseUrl rather than credentials — it is the self-hosted option, so there is no key to supply. openai and anthropic accept an optional baseUrl for gateways and compatible endpoints.

Storage Configuration

Field	Required	Description
`provider`	Yes	`s3`, `azure`, or `gcs`
`credentials`	Yes	Provider credentials
`rootPath`	No	Prefix to scope the connection to a subtree

LLM Configuration

Field	Required	Description
`provider`	Yes	`openai`, `anthropic`, or `ollama`
`credentials`	Yes, except `ollama`	Provider API key
`baseUrl`	Required for `ollama`	Endpoint URL
`defaultModel`	No	Model used when none is specified

Verifying a Connection

Check reachability before relying on a connection:

POST /workspaces/{workspaceSlug}/connections/{connectionId}/verify/

The response contains reachable and, on failure, an error.

Verify after any credential rotation. A connection that stops being reachable will surface as failed syncs rather than an obvious error.

Syncing Files

Storage connections can sync on a schedule or on demand.

POST /workspaces/{workspaceSlug}/connections/{connectionId}/sync/
GET  /workspaces/{workspaceSlug}/connections/{connectionId}/syncs/
GET  /workspaces/{workspaceSlug}/syncs/

Schedule

Field	Description
`syncMode`	`import` pulls into the workspace; `export` pushes out
`scheduleCron`	Cron expression for automatic runs
`deletionPolicy`	`ignore` or `delete` when a remote object disappears

await client.connections.updateConnection(workspaceSlug, connectionId, {
  sync: {
    syncMode: "import",
    scheduleCron: "0 * * * *",
    deletionPolicy: "ignore",
  },
});

deletionPolicy: "delete" removes workspace files when their remote counterpart is gone. Use ignore unless the remote is authoritative.

Sync Status

A sync record reports status, triggerType, recordsSynced, attempt, and errorMessage on failure.

Status	Meaning
`pending`	Queued
`running`	In progress
`completed`	Finished successfully
`failed`	Failed — see `errorMessage`
`cancelled`	Cancelled by a user

Triggers are manual, scheduled, or webhook. Cancel a running sync with:

POST /workspaces/{workspaceSlug}/connections/{connectionId}/syncs/{syncId}/cancel/

Webhooks

GET    /workspaces/{workspaceSlug}/webhooks/
POST   /workspaces/{workspaceSlug}/webhooks/
POST   /workspaces/{workspaceSlug}/webhooks/{webhookId}/test/
DELETE /workspaces/{workspaceSlug}/webhooks/{webhookId}/

Use the test endpoint to confirm delivery before depending on it.

Managing Connections

GET    /workspaces/{workspaceSlug}/connections/
GET    /workspaces/{workspaceSlug}/connections/{connectionId}/
PATCH  /workspaces/{workspaceSlug}/connections/{connectionId}/
DELETE /workspaces/{workspaceSlug}/connections/{connectionId}/

List endpoints accept a provider filter, and workspace-wide syncs also accept status. Set isActive: false to pause a connection without deleting it — scheduled syncs stop, and the configuration is retained.

Next Steps

API Reference

Connection and sync endpoints

TypeScript SDK

connections, syncs, and webhooks

Overview

Features

Cloud

On-Premise

Integrations

Object Storage

LLM Inference

Creating a Connection

Storage Configuration

LLM Configuration

Verifying a Connection

Syncing Files

Schedule

Sync Status

Webhooks

Managing Connections

Next Steps

API Reference

TypeScript SDK

Object Storage

LLM Inference

​Creating a Connection

​Storage Configuration

​LLM Configuration

​Verifying a Connection

​Syncing Files

​Schedule

​Sync Status

​Webhooks

​Managing Connections

​Next Steps

API Reference

TypeScript SDK

Creating a Connection

Storage Configuration

LLM Configuration

Verifying a Connection

Syncing Files

Schedule

Sync Status

Webhooks

Managing Connections

Next Steps