Arke
Build

TypeScript SDK

Using the Arke TypeScript SDK for type-safe API interaction.

Installation

npm install @arke-institute/sdk

Configuration

import { ArkeClient } from '@arke-institute/sdk';

const arke = new ArkeClient({
  baseUrl: 'https://arke-v1.arke.institute',
  token: 'your-jwt-token',
});

// Or with API key
const arke = new ArkeClient({
  baseUrl: 'https://arke-v1.arke.institute',
  apiKey: 'ak_xxxxx',
});

SDK Generation

The SDK is auto-generated from the OpenAPI specification, so it stays in sync with the API. Every endpoint, request schema, and response type is generated from the same source of truth.

Key Operations

The SDK provides typed methods for all API operations:

  • arke.entities.create() / .get() / .update() / .delete()
  • arke.collections.create() / .get() / .addMember()
  • arke.files.upload() / .download()
  • arke.search() / arke.query()

See the API Reference for the full list of available operations.

On this page