TypeScript SDK

At a glance

The TypeScript SDK allows you to integrate Ontologie into your applications in a programmatic and type-safe way. Access the entire platform — ontology, agents, knowledge, workflows, calendar, dashboards, governance, spreadsheets — with complete typing generated from your model.

Inspired by the OSDK pattern: lazy queries, generated types, real-time subscriptions.

What you'll do

• Install the SDK and generate types from your ontology
• Query and manipulate your entities with a type-safe builder
• Receive real-time updates via WebSocket
• Integrate the AI agent, knowledge base, and workflows into your apps
• Build React interfaces with the provided hooks

Packages

The SDK is composed of 6 packages:

Package	Description
@dataforge/sdk-types	Pure runtime types — interfaces, errors, streaming. Zero dependency.
@dataforge/sdk-client	HTTP + WebSocket client — createClient(), ObjectSet, CRUD, namespaces.
@dataforge/sdk-generator	CLI — generates TypeScript types from the ontology manifest.
@ontologie/react	React hooks based on TanStack Query — useObjectSet, useAgent, etc.
@ontologie/oauth	OAuth2 PKCE — browser-safe authentication without client secret.
@dataforge/sdk-python	Python generator — Pydantic models + httpx client.

Dependencies between packages

@dataforge/sdk-types          (zero deps)
       ^
       |
@dataforge/sdk-client          (depends on sdk-types)
       ^
       |  peer dep
@ontologie/react               (peer deps: react, @tanstack/react-query, sdk-client)

@ontologie/oauth               (standalone)
@dataforge/sdk-generator       (standalone)
@dataforge/sdk-python          (standalone)

Quick example

import { createClient } from '@dataforge/sdk-client';

const client = createClient({
  baseUrl: 'https://api.ontologie-growthsystemes.com',
  apiKey: process.env.ONTOLOGIE_API_KEY,
  workspaceId: 'your-workspace-id',
});

// List entities
const entities = await client.ontology.nodes.list();

// Semantic search
const results = await client.knowledge.search('active suppliers');

Complete documentation

Client Portal
The complete SDK documentation (quickstart, client, queries, React hooks, Python, real-time) is available on the Client Portal.

Contact your sales representative or write to support@growthsystemes.com to obtain your access credentials.

Compatibility

Environment	Required
Node.js	>= 18
Browser	All (native fetch required)
TypeScript	>= 5.0 (recommended)
React	>= 18 (for @ontologie/react)
Python	>= 3.9 (for the generated Python SDK)

Limitations

• The SDK is in beta: some interfaces may change between minor versions.
• Real-time streaming (WebSocket) is not yet available for all resources.
• The Python SDK is a client generator — it does not yet cover all TypeScript SDK features.
• The complete documentation is only accessible via the Client Portal.

Expected outcome

By the end of this guide, you will have a type-safe SDK connected to your ontology, with automatically generated types, fluent queries, and real-time updates. Your applications will be able to read, write, and react to data changes programmatically.

Need help?

Write to us: Support and contact.