api module

EdgeImpulseApi

class edgeimpulse.api.EdgeImpulseApi(
		host: str = None,
		key: str = None,
		key_type: str = 'api'
)

Initialize the Edge Impulse Api.

Parameters

• host: str = None

• key: str = None

• key_type: str = 'api'

Class variables

• classify: edgeimpulse_api.api.classify_api.ClassifyApi Classify samples

• client: edgeimpulse_api.api_client.ApiClient The client used for initializing the apis, use set_client to update the client

• deployment: edgeimpulse_api.api.deployment_api.DeploymentApi Work with deployment targets

• devices: edgeimpulse_api.api.devices_api.DevicesApi Work with devices in your project

• dsp: edgeimpulse_api.api.dsp_api.DSPApi Work with digital signal processing (feature extraction)

• export: edgeimpulse_api.api.export_api.ExportApi Export datasets and projects

• feature_flags: edgeimpulse_api.api.feature_flags_api.FeatureFlagsApi Enable and disable feature flags

• host: str Edge Impulse studio host (defaults to production)

• impulse: edgeimpulse_api.api.impulse_api.ImpulseApi Work and manage your impulse

• jobs: edgeimpulse_api.api.jobs_api.JobsApi Start and manage long running jobs

• learn: edgeimpulse_api.api.learn_api.LearnApi Work with keras and pretrained models

• login: edgeimpulse_api.api.login_api.LoginApi Login and authenticate

• optimization: edgeimpulse_api.api.optimization_api.OptimizationApi Optimize the model with the eon tuner

• organization_blocks: edgeimpulse_api.api.organization_blocks_api.OrganizationBlocksApi Work with organization blocks

• organization_create_project: edgeimpulse_api.api.organization_create_project_api.OrganizationCreateProjectApi Automate project creation for organizations

• organization_data: edgeimpulse_api.api.organization_data_api.OrganizationDataApi Work with organization data

• organization_data_campaigns: edgeimpulse_api.api.organization_data_campaigns_api.OrganizationDataCampaignsApi Work with organization campaigns

• organization_jobs: edgeimpulse_api.api.organization_jobs_api.OrganizationJobsApi Start run and manage organization jobs

• organization_pipelines: edgeimpulse_api.api.organization_pipelines_api.OrganizationPipelinesApi Work with organization pipelines

• organization_portals: edgeimpulse_api.api.organization_portals_api.OrganizationPortalsApi Create and manage organization portals

• organizations: edgeimpulse_api.api.organizations_api.OrganizationsApi Work with your organizations

• performance_calibration: edgeimpulse_api.api.performance_calibration_api.PerformanceCalibrationApi Calibrate your model with real world data

• projects: edgeimpulse_api.api.projects_api.ProjectsApi Create and manage your projects

• raw_data: edgeimpulse_api.api.raw_data_api.RawDataApi Work with your project data

• upload_portal: edgeimpulse_api.api.upload_portal_api.UploadPortalApi Create and manage data upload portals

• user: edgeimpulse_api.api.user_api.UserApi Manage user activating, creation, updating and information

Methods

authenticate

edgeimpulse.api.authenticate(
		self,
		key: str,
		key_type: str = 'api',
		host: str = None
) ‑> None

Authenticate against Edge Impulse.

Parameters

• self

• key: str

• key_type: str = 'api'

• host: str = None

Return

None

default_project_id

edgeimpulse.api.default_project_id(
		self
) ‑> int

Retrieve the default project ID from the api key.

Returns: int: The project associated with the api key.

Parameters

• self

Return

int

set_client

edgeimpulse.api.set_client(
		self,
		client: edgeimpulse_api.api_client.ApiClient
) ‑> None

Set the API client and initialize the APIs wit that client.

Parameters

• self

• client: edgeimpulse_api.api_client.ApiClient

Return

None