SDK Overview
Flow-Like provides official SDKs for Node.js/TypeScript and Python that wrap the REST API into ergonomic, type-safe clients. Use them to control workflows, manage files, query LanceDB databases, run chat completions, generate embeddings, from your application code.
Available SDKs
Section titled “Available SDKs”| Language | Package | Install |
|---|---|---|
| Node.js / TypeScript | @flow-like/sdk | npm install @flow-like/sdk |
| Python | flow-like | uv add flow-like |
Feature Matrix
Section titled “Feature Matrix”| Feature | Node.js | Python |
|---|---|---|
| Trigger workflows (sync SSE + async) | ✅ | ✅ |
| Trigger events | ✅ | ✅ |
| File management (upload, download, list, delete) | ✅ | ✅ |
| LanceDB integration (credentials, queries, connections) | ✅ | ✅ |
| Chat Completions (+ streaming) | ✅ | ✅ |
| Responses (+ streaming) | ✅ | ✅ |
| Embeddings | ✅ | ✅ |
| Model discovery (LLMs, embeddings) | ✅ | ✅ |
| Board CRUD | ✅ | ✅ |
| App management | ✅ | ✅ |
| HTTP sinks | ✅ | ✅ |
| Execution monitoring / polling | ✅ | ✅ |
| LangChain integration | ✅ | ✅ |
| Async / await | ✅ native | ✅ a-prefixed methods |
Choose a model API
Section titled “Choose a model API”Model discovery returns api_surface alongside bit_id. Use that field when
choosing the client method:
api_surface | Node.js | Python | Request shape |
|---|---|---|---|
ChatCompletions or absent | chatCompletions() | chat_completions() | messages, max_tokens |
Responses | responses() | responses() | input, max_output_tokens |
These are separate request and response contracts. The server rejects a model sent to the wrong endpoint with HTTP 400 and names the required route. See the Node.js examples and Python examples for discovery and calls.
Authentication
Section titled “Authentication”Both SDKs support two authentication methods:
| Type | Prefix | Header sent | Env variable |
|---|---|---|---|
| Personal Access Token | pat_ | Authorization: pat_{id}.{secret} | FLOW_LIKE_PAT |
| API Key | flk_ | X-API-Key: flk_{app}.{key}.{secret} | FLOW_LIKE_API_KEY |
The SDK sends PATs in Authorization and App API keys in X-API-Key.
Use the explicit pat / apiKey options in Node.js, or pat / api_key in
Python. Python also accepts a token option and detects its prefix. Provide
one credential type at a time; Python rejects simultaneous PAT and API-key
configuration.
Environment variables
Section titled “Environment variables”Both SDKs read from environment variables by default:
export FLOW_LIKE_BASE_URL=https://api.flow-like.comexport FLOW_LIKE_PAT=pat_myid.mysecret# orexport FLOW_LIKE_API_KEY=flk_appid.keyid.secretLangChain Integration
Section titled “LangChain Integration”Both SDKs include optional LangChain-compatible wrappers so you can use Flow-Like models inside LangChain chains, agents, and RAG pipelines.
- Node.js:
import { FlowLikeChatModel, FlowLikeEmbeddings } from "@flow-like/sdk/langchain" - Python:
from flow_like.langchain import FlowLikeChatModel, FlowLikeEmbeddings
See the language-specific pages for installation and usage details.