SDK API Reference / SDKConfig

Interface: SDKConfig

SDK configuration options

Properties

accessToken?

optional accessToken?: string

Access token for Bearer authentication (e.g., from OAuth flows) Takes precedence over apiKey when both are provided

---

apiKey?

optional apiKey?: string

TD API key (format: key_id/secret) Optional when used in browser with cookie-based authentication

---

logLevel?

optional logLevel?: LogLevel

Log level for SDK operations

Default

LogLevel.INFO

---

profile?

optional profile?: string

TD profile name Used for profile-based usage tracking

---

proxy?

optional proxy?: string

HTTP proxy URL for corporate networks with SSL inspection

Supports authentication: http://user:pass@proxy.corp.com:8080

Examples

'http://proxy.corp.com:8080'

'http://user:password@proxy.corp.com:8080'

---

site?

optional site?: TDSite | string & object

TD site/region (accepts canonical names like 'us01', 'ap01' or aliases like 'jp01', 'jp')

Default

'us01'

---

timeout?

optional timeout?: number

Default timeout in milliseconds for HTTP requests. Applied to all API clients (TD, CDP, Workflow, Trino, etc.) Individual requests may override this with their own timeout.

Default

30000