Flow SDK for JavaScript / TypeScript

Official client for the Flow Intelligence Engine API.

Installation

npm install @flowtasks/sdk

Quick Start

import { FlowClient } from "@flowtasks/sdk";

const client = new FlowClient({
  baseUrl: "https://flowtasks.io",
  apiKey: "YOUR_API_KEY",
  organizationId: "YOUR_ORG_ID",
});

// Chat with your documents
const answer = await client.chat("What are the termination conditions?");
console.log(answer);

// Search the knowledge graph
const results = await client.searchGraph("termination clause");
console.log(results);

// Ask the knowledge graph (LLM-powered)
const response = await client.askGraph("Which contracts allow termination without cause?");
console.log(response.answer);

// Legal analysis
const clauses = await client.legalQuery("indemnity clauses", { mode: "deterministic" });
console.log(clauses);

Available Methods

Documents

• listDocuments() -- List all documents
• getDocument(id) -- Get document metadata
• deleteDocument(id) -- Delete a document

Chat / RAG

• chat(message, options?) -- AI-powered query with source citations

Knowledge Graph

• searchGraph(query) -- Search entities and relationships
• getGraphStats() -- Node and edge counts
• askGraph(question) -- Natural-language graph query (LLM)
• reasonGraph(question, options?) -- Intent-aware reasoning
• getGraphVisualization(limit?) -- Full graph data for rendering
• getEntityNeighbors(name, depth?) -- Explore entity connections

Legal Analysis

• legalClauseTypes() -- Available clause types
• legalClauses(docId) -- Extract clauses from a document
• legalDiff(docA, docB) -- Compare clauses between documents
• legalQuery(query, options?) -- Query across all clauses

Ontology

• listDomains() -- Built-in domain ontologies
• createOntology(params) -- Create custom ontology
• listCustomOntologies() -- List custom ontologies
• getResolvedOntology(domain) -- Merged core + custom ontology

Agent

• agentRun(params?) -- Trigger an agent run
• listAgentRuns() -- Past agent runs
• listRiskSignals() -- Detected risk signals

Workflows

• listWorkflows() / createWorkflow(params) / runWorkflow(id)

Compliance

• listComplianceChecks() / runComplianceScan(params?)

Webhooks

• listWebhooks() / createWebhook(params)

Usage

• getUsage() -- Current usage and quota

Error Handling

import { FlowClient, FlowAPIError } from "@flowtasks/sdk";

try {
  const result = await client.chat("Summarize the agreement");
} catch (err) {
  if (err instanceof FlowAPIError) {
    console.error(`API error ${err.statusCode}: ${err.detail}`);
  }
}

Links

• Interactive API Docs
• OpenAPI Schema

License

MIT