Skip to main content
Call your deployed agents with the Reminix TypeScript SDK. Invoke agents and stream responses in real-time.

Installation

npm install @reminix/sdk
Or with other package managers:
pnpm add @reminix/sdk
yarn add @reminix/sdk

Configuration

Basic Setup

import Reminix from '@reminix/sdk';

// Using API key directly
const client = new Reminix({ apiKey: 'reminix_sk_...' });

// Using environment variable (recommended)
const client = new Reminix({ apiKey: process.env.REMINIX_API_KEY });
The SDK automatically reads from the REMINIX_API_KEY environment variable if no key is provided.

Configuration Options

import Reminix from '@reminix/sdk';

const client = new Reminix({
  apiKey: 'reminix_sk_...',
  
  // Custom base URL (for self-hosted or testing)
  baseURL: 'https://api.reminix.com/v1',
  
  // Request timeout in milliseconds
  timeout: 60000,
  
  // Custom headers
  defaultHeaders: { 'X-Custom-Header': 'value' }
});

Quick Example

import Reminix from '@reminix/sdk';

const client = new Reminix();

// Invoke a task-oriented agent
const response = await client.agents.invoke('my-agent', {
  prompt: 'Analyze this data'
});
console.log(response.content);

// Invoke a chat agent
const chatResponse = await client.agents.invoke('chat-assistant', {
  messages: [{ role: 'user', content: 'Hello!' }]
});
console.log(chatResponse.message.content);

TypeScript Types

The SDK is fully typed. Import types when needed for explicit typing:
import Reminix from '@reminix/sdk';
import type { ExecuteResponse, Message } from '@reminix/sdk';

const client = new Reminix();

// Types are inferred automatically
const response = await client.agents.invoke('my-agent', {
  prompt: 'Analyze this'
});

// Explicit typing when needed (e.g., for function parameters)
function processMessages(messages: Message[]) {
  console.log(messages.length);
}

Next Steps