The main entry point to the API. This is usually a short-lived object, but there is no reason to not use it for longer. For better organization, the API is namespaced in about a dozen different namespaces. These namespaces are also used in the JS SDK. Each namespaced API is available as a readonly attribute on the BimWorksClient.



bim: Bim
checks: Checks
client: Client
fs: Fs
geometry2d: Geometry2d
geometry3d: Geometry3d
gis: Gis
ifc: Ifc
registerExpiredTokenHandler: ((handler) => void)

Type declaration

render: Render
tokens: Tokens
upload: Upload


  • Parameters

    • username: string
    • password: string

    Returns Promise<void> | Promise<Error>