api module#

Convenience API to initialize and access all Edge impulse.

class edgeimpulse.api.EdgeImpulseApi(
host: str | None = None,
key: str | None = None,
key_type: str = 'api',
)[source]#

Bases: object

Initialize the Edge Impulse Api.

Parameters:
  • host (str, optional) – The host address. None will use the production host. Defaults to None

  • key (str, optional) – The authentication key to use. If none given, it will use no authentication.

  • key_type (str, optional) – The type of key. Can be api, jwt or jwt_http. Defaults to api.

authenticate(
key: str,
key_type: str = 'api',
host: str | None = None,
) None[source]#

Authenticate against Edge Impulse.

Parameters:
  • key (str) – The authentication key to use. If none give, it will use no authentication.

  • key_type (str, optional) – The type of key. Can be api, jwt or jwt_http. Defaults to api.

  • host (str, optional) – The host address. None will use the production host. Defaults to None

classify: ClassifyApi#

Classify samples

client: ApiClient#

The client used for initializing the apis, use set_client to update the client

default_project_id() int[source]#

Retrieve the default project ID from the api key.

Returns:

The project associated with the api key.

Return type:

int

deployment: DeploymentApi#

Work with deployment targets

devices: DevicesApi#

Work with devices in your project

dsp: DSPApi#

Work with digital signal processing (feature extraction)

export: ExportApi#

Export datasets and projects

feature_flags: FeatureFlagsApi#

Enable and disable feature flags

host: str#

Edge Impulse studio host (defaults to production)

impulse: ImpulseApi#

Work and manage your impulse

jobs: JobsApi#

Start and manage long running jobs

learn: LearnApi#

Work with keras and pretrained models

login: LoginApi#

Login and authenticate

optimization: OptimizationApi#

Optimize the model with the eon tuner

organization_blocks: OrganizationBlocksApi#

Work with organization blocks

organization_create_project: OrganizationCreateProjectApi#

Automate project creation for organizations

organization_data: OrganizationDataApi#

Work with organization data

organization_data_campaigns: OrganizationDataCampaignsApi#

Work with organization campaigns

organization_jobs: OrganizationJobsApi#

Start run and manage organization jobs

organization_pipelines: OrganizationPipelinesApi#

Work with organization pipelines

organization_portals: OrganizationPortalsApi#

Create and manage organization portals

organizations: OrganizationsApi#

Work with your organizations

performance_calibration: PerformanceCalibrationApi#

Calibrate your model with real world data

projects: ProjectsApi#

Create and manage your projects

raw_data: RawDataApi#

Work with your project data

set_client(client: ApiClient) None[source]#

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

Parameters:

client – The API client.

upload_portal: UploadPortalApi#

Create and manage data upload portals

user: UserApi#

Manage user activating, creation, updating and information