Skip to main content

​
Installation

npm install @reminix/sdk

​
Usage

import Reminix from "@reminix/sdk"

const client = new Reminix({ apiKey: "your-api-key" })

​
Configuration

​
apiKey
string
required
Your project API key or personal access token. Can also be set via the REMINIX_API_KEY environment variable.
​
baseURL
string
API base URL. Defaults to https://api.reminix.com/v1.
​
timeout
number
Request timeout in milliseconds. Defaults to 60000.
​
defaultHeaders
Record<string, string>
Headers included in every request. Use for PAT authentication with the X-Project header.

​
Environment Variables

You can set your API key as an environment variable instead of passing it directly. 
export REMINIX_API_KEY="reminix_sk_..."

// API key auto-detected from environment
const client = new Reminix()
When the apiKey parameter is omitted, the SDK automatically reads from the REMINIX_API_KEY environment variable.

​
Framework Packages

Reminix provides optional integration packages for popular AI frameworks. Install them alongside the base SDK to use framework-specific helpers with your Reminix agents.
PackageFrameworkAlso in Python?
@reminix/openaiOpenAI integrationYes
@reminix/anthropicAnthropic integrationYes
@reminix/langchainLangChain integrationYes
@reminix/googleGoogle AI integrationYes
@reminix/vercel-aiVercel AI SDK integrationTypeScript only
Install any combination you need: 
npm install @reminix/sdk @reminix/openai @reminix/anthropic
Framework packages are optional. The base @reminix/sdk package is all you need to invoke and chat with agents.

​
Next steps

invoke()

Call task agents and stream results.

chat()

Build multi-turn conversations.

Creating Agents

Define and serve agents from your own code.

Error Handling

Catch typed errors and add retries.