Client Usage

Call agents via the Reminix API

Call deployed agents from your TypeScript application.

Invoke an Agent

import { Client } from '@reminix/client';

const client = new Client({
  apiKey: 'reminix_sk_...',
});

const result = await client.agents.invoke('my-agent', {
  input: { name: 'World' },
});

console.log(result.output);  // "Hello, World!"

Chat with an Agent

const response = await client.agents.chat('my-agent', {
  messages: [
    { role: 'user', content: 'Hello!' },
  ],
});

console.log(response.message.content);

Multi-turn Conversation

const messages: Array<{ role: string; content: string }> = [];

// First turn
messages.push({ role: 'user', content: 'Hello!' });
const response1 = await client.agents.chat('my-agent', { messages });
messages.push({ role: 'assistant', content: response1.message.content });

// Second turn
messages.push({ role: 'user', content: 'How are you?' });
const response2 = await client.agents.chat('my-agent', { messages });
console.log(response2.message.content);

Get Project Info

const project = await client.project.get();
console.log(`Project: ${project.name}`);

Error Handling

import {
  Client,
  AuthenticationError,
  APIError,
  NetworkError,
} from '@reminix/client';

const client = new Client({ apiKey: 'reminix_sk_...' });

try {
  const result = await client.agents.invoke('my-agent', { input: {} });
} catch (error) {
  if (error instanceof AuthenticationError) {
    console.error('Invalid API key');
  } else if (error instanceof APIError) {
    console.error(`API error: ${error.status} - ${error.message}`);
  } else if (error instanceof NetworkError) {
    console.error('Network error');
  }
}

Common Errors

ErrorCause
AuthenticationErrorInvalid or missing API key
APIError (404)Agent not found
APIError (400)Invalid request
NetworkErrorConnection failed

Next Steps

On this page