Open-source, secure environment with real-world tools for enterprise-grade agents.
Python agentaiai-agentai-agentscode-interpretercopilotdevelopmentdevtoolsgptgpt-4javascriptllmnextjsopenaipythonreactsoftwaretypescript
import createClient, { FetchResponse } from 'openapi-fetch'
import type { components, paths } from './schema.gen'
import { defaultHeaders } from './metadata'
import { createApiFetch } from './http2'
import { ConnectionConfig } from '../connectionConfig'
import {
AuthenticationError,
RateLimitError,
ServiceBusyError,
SandboxError,
} from '../errors'
import { createApiLogger } from '../logs'
import { withRetry } from '../retry'
/**
* Map an API error code and message to the matching error class — the same
* mapping {@link handleApiError} applies to HTTP responses, usable for error
* objects embedded in response bodies (e.g. per-fork results).
*/
export function apiErrorFromCode(
code: number,
content: unknown,
errorClass: new (
message: string,
stackTrace?: string
) => Error = SandboxError,
stackTrace?: string
): Error {
if (code === 401) {
const message = 'Unauthorized, please check your credentials.'
return new AuthenticationError(
content ? `${message} - ${content}` : message
)
}
if (code === 429) {
const message = 'Rate limit exceeded, please try again later'
return new RateLimitError(content ? `${message} - ${content}` : message)
}
if (code === 503) {
const message = 'Service temporarily unavailable, please retry'
return new ServiceBusyError(content ? `${message} - ${content}` : message)
}
const err = new errorClass(`${code}: ${content}`, stackTrace)
if (err instanceof SandboxError) {
err.statusCode = code
}
return err
}
export function handleApiError(
response: FetchResponse<any, any, any>,
errorClass: new (
message: string,
stackTrace?: string
) => Error = SandboxError,
stackTrace?: string
): Error | undefined {
// openapi-fetch leaves `error` undefined for non-2xx responses with
// Content-Length: 0, so check the status instead
if (response.response.ok) {
return
}
const status = response.response.status
if (status === 401 || status === 429 || status === 503) {
return apiErrorFromCode(
status,
response.error?.message ?? response.error,
errorClass,
stackTrace
)
}
return apiErrorFromCode(
status,
response.error?.message || response.error || response.response.statusText,
errorClass,
stackTrace
)
}
/**
* Client for interacting with the E2B API.
*/
class ApiClient {
readonly api: ReturnType<typeof createClient<paths>>
constructor(
config: ConnectionConfig,
opts: {
requireApiKey?: boolean
} = {}
) {
if ((opts.requireApiKey ?? true) && !config.apiKey) {
throw new AuthenticationError(
'API key is required, please visit the API Keys tab at https://e2b.dev/dashboard?tab=keys to get your API key. ' +
'You can either set the environment variable `E2B_API_KEY` ' +
"or you can pass it directly to the sandbox like Sandbox.create({ apiKey: 'e2b_...' })"
)
}
this.api = createClient<paths>({
baseUrl: config.apiUrl,
fetch: withRetry(
createApiFetch(config),
config.retries,
config.requestTimeoutMs
),
// In HTTP 1.1, all connections are considered persistent unless declared otherwise
// keepalive: true,
headers: {
...defaultHeaders,
...(config.apiKey && { 'X-API-KEY': config.apiKey }),
...config.headers,
},
querySerializer: {
array: {
style: 'form',
explode: false,
},
},
})
if (config.logger) {
this.api.use(createApiLogger(config.logger))
}
}
}
export type { components, paths }
export { ApiClient }