Error Handling

The SDK provides a comprehensive error handling system that helps you handle different types of errors gracefully and get meaningful error information for debugging.

Error Types

The SDK defines several specific error types that inherit from a base UiPathError class:

AuthenticationError

Thrown when authentication fails (401 status codes).

Common scenarios: - Invalid credentials - Expired token - Missing authentication

import { AuthenticationError, isAuthenticationError } from '@uipath/uipath-typescript';

try {
  await sdk.initialize();
} catch (error) {
  if (isAuthenticationError(error)) {
    console.log('Authentication failed:', error.message);
    // Handle re-authentication
  }
}

AuthorizationError

Thrown when access is denied (403 status codes).

Common scenarios: - Insufficient permissions - Access denied to specific folder - Scope limitations

import { AuthorizationError, isAuthorizationError } from '@uipath/uipath-typescript';

try {
  const assets = await sdk.assets.getAll({ folderId: 12345 });
} catch (error) {
  if (isAuthorizationError(error)) {
    console.log('Access denied:', error.message);
    // Handle permission error
  }
}

ValidationError

Thrown when validation fails (400 status codes).

Common scenarios: - Invalid input parameters - Missing required fields - Invalid data format

import { ValidationError, isValidationError } from '@uipath/uipath-typescript';

try {
  await sdk.processes.start({
    releaseKey: 'invalid-key'
  });
} catch (error) {
  if (isValidationError(error)) {
    console.log('Validation failed:', error.message);
    // Handle validation errors
  }
}

NotFoundError

Thrown when requested resources are not found (404 status codes).

Common scenarios: - Resource doesn't exist - Folder not found - Process not found

import { NotFoundError, isNotFoundError } from '@uipath/uipath-typescript';

try {
  const asset = await sdk.assets.getById(99999);
} catch (error) {
  if (isNotFoundError(error)) {
    console.log('Asset not found:', error.message);
    // Handle missing resource
  }
}

RateLimitError

Thrown when rate limits are exceeded (429 status codes).

Common scenarios: - Too many requests - API rate limiting

import { RateLimitError, isRateLimitError } from '@uipath/uipath-typescript';

try {
  await sdk.assets.getAll();
} catch (error) {
  if (isRateLimitError(error)) {
    console.log('Rate limit exceeded:', error.message);
    // Implement retry logic with backoff
  }
}

ServerError

Thrown when server errors occur (5xx status codes).

Common scenarios: - Internal server error - Service unavailable - Gateway timeout

import { ServerError, isServerError } from '@uipath/uipath-typescript';

try {
  await sdk.queues.getAll();
} catch (error) {
  if (isServerError(error)) {
    console.log('Server error:', error.message);
    // Handle server-side errors
  }
}

NetworkError

Thrown when network-related errors occur.

Common scenarios: - Connection timeout - Request aborted - DNS resolution failure - Network connectivity issues

import { NetworkError, isNetworkError } from '@uipath/uipath-typescript';

try {
  await sdk.processes.getAll();
} catch (error) {
  if (isNetworkError(error)) {
    console.log('Network error:', error.message);
    // Handle network issues
  }
}

Error Information

Getting Error Details

import { getErrorDetails } from '@uipath/uipath-typescript';

try {
  await sdk.assets.getAll();
} catch (error) {
  const details = getErrorDetails(error);
  console.log('Error message:', details.message);
  console.log('Status code:', details.statusCode);
}

Accessing All Error Properties

import { UiPathError } from '@uipath/uipath-typescript';

try {
  const process = await sdk.maestro.processes.getById('invalid-id');
} catch (error) {
  if (error instanceof UiPathError) {
    // Access common error properties
    console.log('Error Type:', error.type);
    console.log('Message:', error.message);
    console.log('Status Code:', error.statusCode);
    console.log('Request ID:', error.requestId);
    console.log('Timestamp:', error.timestamp);
    console.log('error stack trace:', error.stack);

    // Get detailed debug information including stack trace
    const debugInfo = error.getDebugInfo();
  }
}

Debug Information

try {
  await sdk.processes.start({ releaseKey: 'test' });
} catch (error) {
  if (error instanceof UiPathError) {
    const debugInfo = error.getDebugInfo();
    console.log('Debug info:', JSON.stringify(debugInfo, null, 2));
  }
}