Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.edgeimpulse.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Modules

​
Classes

​
EdgeImpulseApi

edgeimpulse.experimental.EdgeImpulseApi(
	host: str | None = None,
	key: str | None = None,
	key_type: str = 'api'
)
Initialize the Edge Impulse Api.
Parameters
hoststr | None = None
keystr | None = None
key_typestr = 'api'
Instance variables
classifyedgeimpulse_api.api.classify_api.ClassifyApi
clientedgeimpulse_api.api_client.ApiClient
deploymentedgeimpulse_api.api.deployment_api.DeploymentApi
devicesedgeimpulse_api.api.devices_api.DevicesApi
dspedgeimpulse_api.api.dsp_api.DSPApi
exportedgeimpulse_api.api.export_api.ExportApi
hoststr | None
impulseedgeimpulse_api.api.impulse_api.ImpulseApi
jobsedgeimpulse_api.api.jobs_api.JobsApi
learnedgeimpulse_api.api.learn_api.LearnApi
loginedgeimpulse_api.api.login_api.LoginApi
optimizationedgeimpulse_api.api.optimization_api.OptimizationApi
organization_blocksedgeimpulse_api.api.organization_blocks_api.OrganizationBlocksApi
organization_create_projectedgeimpulse_api.api.organization_create_project_api.OrganizationCreateProjectApi
organization_dataedgeimpulse_api.api.organization_data_api.OrganizationDataApi
organization_data_campaignsedgeimpulse_api.api.organization_data_campaigns_api.OrganizationDataCampaignsApi
organization_jobsedgeimpulse_api.api.organization_jobs_api.OrganizationJobsApi
organization_pipelinesedgeimpulse_api.api.organization_pipelines_api.OrganizationPipelinesApi
organization_portalsedgeimpulse_api.api.organization_portals_api.OrganizationPortalsApi
organizationsedgeimpulse_api.api.organizations_api.OrganizationsApi
performance_calibrationedgeimpulse_api.api.performance_calibration_api.PerformanceCalibrationApi
projectsedgeimpulse_api.api.projects_api.ProjectsApi
raw_dataedgeimpulse_api.api.raw_data_api.RawDataApi
upload_portaledgeimpulse_api.api.upload_portal_api.UploadPortalApi
useredgeimpulse_api.api.user_api.UserApi
METHODS

​
authenticate

edgeimpulse.experimental.EdgeImpulseApi.authenticate(
	self,
	key: str,
	key_type: str = 'api',
	host: str | None = None
) ‑> None
Authenticate against Edge Impulse.
Parameters
self
keystr
key_typestr = 'api'
hoststr | None = None
Returns
None

​
default_project_id

edgeimpulse.experimental.EdgeImpulseApi.default_project_id(
	self
) ‑> int
Get the default project ID from the provided API key. Returns: int: The project associated with the api key.
Parameters
self
Returns
int

​
run_organization_job_until_completion

edgeimpulse.experimental.EdgeImpulseApi.run_organization_job_until_completion(
	self,
	organization_id: int,
	job_id: int,
	data_cb=None,
	client=None,
	timeout_sec: int | None = None
) ‑> None
Runs an organization job until completion.
Parameters
self
organization_idint
job_idint
data_cb=None
client=None
timeout_secint | None = None
Returns
None

​
run_project_job_until_completion

edgeimpulse.experimental.EdgeImpulseApi.run_project_job_until_completion(
	self,
	job_id: int,
	data_cb=None,
	client=None,
	project_id: int | None = None,
	timeout_sec: int | None = None
) ‑> None
Runs a project job until completion.
Parameters
self
job_idint
data_cb=None
client=None
project_idint | None = None
timeout_secint | None = None
Returns
None

​
set_client

edgeimpulse.experimental.EdgeImpulseApi.set_client(
	self,
	client: edgeimpulse_api.api_client.ApiClient
) ‑> None
Set the API client and initialize the APIs wit that client.
Parameters
self
clientedgeimpulse_api.api_client.ApiClient
Returns
None