Sandbox Error Handling

​

Overview

​

Import

import {
    HopxError,
    APIError,
    AuthenticationError,
    NotFoundError,
    ValidationError,
    RateLimitError,
    ResourceLimitError,
    ServerError,
    NetworkError,
    TimeoutError
} from '@hopx-ai/sdk';

​

Base Error

​

HopxError

• message (string): Error message
• code (string, optional): Error code
• requestId (string, optional): Request ID for debugging
• statusCode (number, optional): HTTP status code
• details (Record<string, any>, optional): Additional error details

​

API Errors

​

APIError

​

AuthenticationError

• Invalid or missing API key
• Expired authentication token

​

NotFoundError

• Sandbox not found
• Template not found
• File not found

​

ValidationError

• Invalid parameters
• Missing required fields

​

RateLimitError

• retryAfter (number, optional): Seconds to wait before retrying

​

ResourceLimitError

• limit (number): Resource limit
• current (number): Current usage
• available (number): Available resources

​

ServerError

​

Network Errors

​

NetworkError

​

TimeoutError

​

Error Handling Examples

​

Example 1: Basic Error Handling

import { Sandbox, HopxError } from '@hopx-ai/sdk';

try {
    const sandbox = await Sandbox.create({ template: 'code-interpreter' });
    const result = await sandbox.runCode("print('Hello')");
} catch (error) {
    if (error instanceof HopxError) {
        console.error(`Error: ${error.message}`);
        if (error.statusCode) {
            console.error(`Status: ${error.statusCode}`);
        }
    }
}

​

Example 2: Specific Error Handling

import { Sandbox, AuthenticationError, NotFoundError } from '@hopx-ai/sdk';

try {
    const sandbox = await Sandbox.create({ template: 'code-interpreter' });
} catch (error) {
    if (error instanceof AuthenticationError) {
        console.error('Authentication failed. Check your API key.');
    } else if (error instanceof NotFoundError) {
        console.error('Template not found.');
    }
}

​

Related Classes

• Types - TypeScript type definitions
• Sandbox - Sandbox operations that may throw errors

​

See Also

• Types - Learn about type definitions
• Core Concepts: Errors - Learn about error handling

​

Next Steps

• Error Handling Basics - Practical error handling patterns
• Sandbox Operations - See errors in action
• API Errors - Understand API error responses
• CLI Reference - Use HopX from the command line
• Troubleshooting - Common issues and solutions