npm install @relayplane/sdk

yarn add @relayplane/sdk

import { configure, optimize } from '@relayplane/sdk';

// Configure with RelayPlane API key
configure({ 
  apiKey: process.env.RELAY_API_KEY 
});

// Use optimization features
const response = await optimize({
  to: 'gpt-4',
  payload: {
    model: 'gpt-4',
    messages: [{ role: 'user', content: 'Complex analysis task' }]
  }
}, {
  strategy: 'fallback',
  fallbackChain: ['gpt-4', 'claude-3-sonnet', 'gpt-3.5-turbo'],
  maxCost: 0.50
});

# Set provider API keys in environment
export ANTHROPIC_API_KEY="sk-ant-..."
export OPENAI_API_KEY="sk-..."
export GOOGLE_API_KEY="AIza..."

# Use relay without RelayPlane API key
import { relay } from '@relayplane/sdk';
const response = await relay({ to: 'claude-sonnet-4-20250514', payload: {...} });

curl -H "x-api-key: your-relay-api-key" https://api.relayplane.com/api/health

import { relay } from '@relayplane/sdk';

const response = await relay({
  to: 'claude-sonnet-4-20250514',     // Target model (auto-inferred to payload)
  payload: {                          // Model-specific payload  
    max_tokens: 1000,
    messages: [
      { role: 'user', content: 'Your prompt here' }
    ]
  },
  metadata: {                         // Optional tracking data
    user_id: 'user-123',
    session: 'session-456'
  }
});

console.log(response.relay_id);      // Unique request ID
console.log(response.latency_ms);    // Request latency
console.log(response.body);          // Model response

{
  "relay_id": "evt_123",           // Unique request identifier
  "status_code": 200,              // HTTP status from provider
  "latency_ms": 450,               // Total request latency
  "body": {...},                   // Provider response body
  "fallback_used": false           // Whether fallback was triggered
}

import { relay } from '@relayplane/sdk';

// Enable streaming in payload  
const response = await relay({
  to: 'claude-sonnet-4-20250514',
  payload: {
    max_tokens: 1000,
    stream: true,                    // Enable streaming
    messages: [
      { role: 'user', content: 'Write a poem about AI' }
    ]
  }
});

// Handle streaming response
for await (const chunk of response.stream) {
  process.stdout.write(chunk);
}
console.log('\nStreaming complete!');

fetch('https://api.relayplane.com/api/relay', {
  method: 'POST',
  headers: {
    'x-api-key': 'your-relay-api-key',
    'Content-Type': 'application/json',
    'Accept': 'text/event-stream'
  },
  body: JSON.stringify({
    to: 'claude-sonnet-4-20250514',
    payload: { stream: true, /* ... */ }
  })
}).then(response => {
  const reader = response.body.getReader();
  // Handle streamed chunks
});

import { relay, RelayError, RelayTimeoutError } from '@relayplane/sdk';

try {
  const response = await relay({
    to: 'claude-sonnet-4-20250514',
    payload: { /* ... */ }
  });
} catch (error) {
  if (error instanceof RelayTimeoutError) {
    console.log('Request timed out');
  } else if (error instanceof RelayError) {
    console.log('Relay error:', error.message);
    console.log('Error code:', error.code);
  } else {
    console.log('Unexpected error:', error);
  }
}

import { relay, RelayRateLimitError } from '@relayplane/sdk';

async function relayWithBackoff(request, maxRetries = 3) {
  for (let attempt = 1; attempt <= maxRetries; attempt++) {
    try {
      return await relay(request);
    } catch (error) {
      if (error instanceof RelayRateLimitError && attempt < maxRetries) {
        const delay = Math.pow(2, attempt) * 1000; // Exponential backoff
        await new Promise(resolve => setTimeout(resolve, delay));
        continue;
      }
      throw error;
    }
  }
}