Rate Limiting

Standard Endpoints

Standard endpoints include basic operations such as retrieving, updating, or deleting resources.

AI Diagnostic Endpoints

AI diagnostic endpoints perform complex medical analysis and require more computational resources.

Bulk Operations

Bulk operations handle multiple records in a single request and have special rate limiting rules.

Recommended Approach

When your application receives a rate limit error (HTTP 429), follow these best practices:

1. Respect the Retry-After header, which tells you how long to wait before retrying.
2. Implement exponential backoff with jitter when retrying to avoid creating sudden spikes in traffic.
3. Consider caching responses where appropriate to reduce the number of API calls.
4. Monitor the X-RateLimit-Remaining header to adjust your request patterns before hitting limits.

Example: Handling Rate Limiting with Exponential Backoff

import { TelesoftAI, TelesoftAPIError } from '@telesoft/healthcare-sdk';

// Configure the SDK
const telesoft = new TelesoftAI({
  apiKey: 'YOUR_API_KEY',
  environment: 'production'
});

// Retry function with exponential backoff
async function retryWithBackoff(fn, maxRetries = 5) {
  let retries = 0;
  
  while (true) {
    try {
      return await fn();
    } catch (error) {
      if (!(error instanceof TelesoftAPIError) || 
          error.status !== 429 || 
          retries >= maxRetries) {
        throw error; // Not a rate limit error or max retries exceeded
      }
      
      retries++;
      
      // Get retry time from header or calculate with exponential backoff
      let retryAfterSeconds;
      if (error.headers && error.headers['retry-after']) {
        retryAfterSeconds = parseInt(error.headers['retry-after'], 10);
      } else {
        // Exponential backoff with jitter: 2^retries * 100ms + random jitter
        const baseDelay = Math.pow(2, retries) * 100;
        const jitter = Math.random() * 100;
        retryAfterSeconds = (baseDelay + jitter) / 1000;
      }
      
      console.log(`Rate limited. Retrying in ${retryAfterSeconds} seconds. Attempt ${retries} of ${maxRetries}`);
      
      // Wait before retrying
      await new Promise(resolve => setTimeout(resolve, retryAfterSeconds * 1000));
    }
  }
}

// Example usage
async function getDifferentialDiagnosis(symptoms) {
  return retryWithBackoff(async () => {
    return await telesoft.diagnostics.getDifferential({
      symptoms,
      patientInfo: {
        age: 35,
        sex: 'female'
      }
    });
  });
}

// Call the function
getDifferentialDiagnosis(['fever', 'cough', 'fatigue'])
  .then(result => console.log('Diagnosis:', result))
  .catch(error => console.error('Error:', error));