Skip to main content

DynamoFL - Client Initialization

DynamoFL(api_key, host?, metadata?)

Initializes the DynamoFL client instance connection. The DynamoFL object is your entrypoint to the rest of the DynamoFL SDK.

Your DynamoFL API key is required when calling this function, as it identifies your account to the DynamoFL server. To create an API key, navigate to the profile page on DynamoFL and generate a new access token.

Method Parameters

api_key | required string

API key attained from UI profile page.


host | optional string

API server identifier, https://api.dynamo.ai by default.


metadata | optional dict

Default metadata to apply to all datasources attached by the instance. Not required for penetration testing or model evaluation.


Returns

DynamoFL object.

Example

# Initialize instance on default dynamofl server.
dfl = DynamoFL('56dfae3d-12aa-4148-988e-b71aebb8a75c')

# Initialize instance against a locally hosted server
dfl = DynamoFL('56dfae3d-12aa-4148-988e-b71aebb8a75c', host='http://localhost:3000')