projects_api module

ProjectsApi

class edgeimpulse_api.api.projects_api.ProjectsApi(
		api_client=None
)

Parameters

• api_client=None

Methods

add_collaborator

edgeimpulse_api.api.projects_api.add_collaborator(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		add_collaborator_request: edgeimpulse_api.models.add_collaborator_request.AddCollaboratorRequest,
		**kwargs
) ‑> edgeimpulse_api.models.entity_created_response.EntityCreatedResponse

Add collaborator

Add a collaborator to a project.

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• add_collaborator_request: edgeimpulse_api.models.add_collaborator_request.AddCollaboratorRequest

• **kwargs

Return

edgeimpulse_api.models.entity_created_response.EntityCreatedResponse

add_project_api_key

edgeimpulse_api.api.projects_api.add_project_api_key(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		add_project_api_key_request: edgeimpulse_api.models.add_project_api_key_request.AddProjectApiKeyRequest,
		**kwargs
) ‑> edgeimpulse_api.models.add_api_key_response.AddApiKeyResponse

Add API key

Add an API key. If you set developmentKey to true this flag will be removed from the current development API key.

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• add_project_api_key_request: edgeimpulse_api.models.add_project_api_key_request.AddProjectApiKeyRequest

• **kwargs

Return

edgeimpulse_api.models.add_api_key_response.AddApiKeyResponse

add_project_hmac_key

edgeimpulse_api.api.projects_api.add_project_hmac_key(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		add_hmac_key_request: edgeimpulse_api.models.add_hmac_key_request.AddHmacKeyRequest,
		**kwargs
) ‑> edgeimpulse_api.models.entity_created_response.EntityCreatedResponse

Add HMAC key

Add an HMAC key. If you set developmentKey to true this flag will be removed from the current development HMAC key.

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• add_hmac_key_request: edgeimpulse_api.models.add_hmac_key_request.AddHmacKeyRequest

• **kwargs

Return

edgeimpulse_api.models.entity_created_response.EntityCreatedResponse

clear_ai_actions_proposed_changes

edgeimpulse_api.api.projects_api.clear_ai_actions_proposed_changes(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		action_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='AI Action ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Clear AI Actions proposed changes

Remove all proposed changes for an AI Actions job.

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• action_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='AI Action ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

create_ai_action

edgeimpulse_api.api.projects_api.create_ai_action(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.entity_created_response.EntityCreatedResponse

Create AI Action

Create a new AI Action.

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.entity_created_response.EntityCreatedResponse

create_project

edgeimpulse_api.api.projects_api.create_project(
		self,
		create_project_request: edgeimpulse_api.models.create_project_request.CreateProjectRequest,
		**kwargs
) ‑> edgeimpulse_api.models.create_project_response.CreateProjectResponse

Create new project

Create a new project. This API can only be called using a JWT token.

Parameters

• self

• create_project_request: edgeimpulse_api.models.create_project_request.CreateProjectRequest

• **kwargs

Return

edgeimpulse_api.models.create_project_response.CreateProjectResponse

delete_ai_action

edgeimpulse_api.api.projects_api.delete_ai_action(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		action_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='AI Action ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Delete AI Actions config

Deletes an AI Actions.

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• action_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='AI Action ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

delete_project

edgeimpulse_api.api.projects_api.delete_project(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Remove project

Remove the current project, and all data associated with it. This is irrevocable!

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

delete_version

edgeimpulse_api.api.projects_api.delete_version(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		version_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Version ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Delete versions

Delete a version. This does not delete the version from cold storage.

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• version_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Version ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

download_csv_wizard_config

edgeimpulse_api.api.projects_api.download_csv_wizard_config(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> str

Download CSV Wizard config

Returns a JSON file with the current CSV wizard config. If there is no config this will throw a 5xx error.

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• **kwargs

Return

str

download_csv_wizard_uploaded_file

edgeimpulse_api.api.projects_api.download_csv_wizard_uploaded_file(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> str

Download CSV Wizard uploaded file

Returns the file that was uploaded when the CSV wizard was configured. If there is no config this will throw a 5xx error.

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• **kwargs

Return

str

get_ai_action

edgeimpulse_api.api.projects_api.get_ai_action(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		action_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='AI Action ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.get_ai_action_response.GetAIActionResponse

Get AI Actions config

Get an AI Actions config

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• action_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='AI Action ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.get_ai_action_response.GetAIActionResponse

get_csv_wizard_uploaded_file_info

edgeimpulse_api.api.projects_api.get_csv_wizard_uploaded_file_info(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.get_csv_wizard_uploaded_file_info.GetCsvWizardUploadedFileInfo

Get CSV Wizard uploaded file info

Returns whether the file that was uploaded when the CSV wizard was configured is available.

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.get_csv_wizard_uploaded_file_info.GetCsvWizardUploadedFileInfo

get_model_variants

edgeimpulse_api.api.projects_api.get_model_variants(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		impulse_id: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Impulse ID. If this is unset then the default impulse is used.', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.get_model_variants_response.GetModelVariantsResponse

Get a list of all model variants available for this project

Get a list of model variants applicable to all trained learn blocks in this project.

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• impulse_id: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Impulse ID. If this is unset then the default impulse is used.', extra={})] = None

• **kwargs

Return

edgeimpulse_api.models.get_model_variants_response.GetModelVariantsResponse

get_new_ai_action

edgeimpulse_api.api.projects_api.get_new_ai_action(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.get_ai_action_response.GetAIActionResponse

Get new AI Actions config

Get the AI Actions config for a new action

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.get_ai_action_response.GetAIActionResponse

get_project_data_axes_summary

edgeimpulse_api.api.projects_api.get_project_data_axes_summary(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		include_disabled: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description='Whether to include disabled samples. Defaults to true', extra={})] = None,
		include_not_processed: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description='Whether to include non-processed samples. Defaults to true', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.project_data_axes_summary_response.ProjectDataAxesSummaryResponse

Get data axes summary

Get a list of axes that are present in the training data.

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• include_disabled: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description='Whether to include disabled samples. Defaults to true', extra={})] = None

• include_not_processed: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description='Whether to include non-processed samples. Defaults to true', extra={})] = None

• **kwargs

Return

edgeimpulse_api.models.project_data_axes_summary_response.ProjectDataAxesSummaryResponse

get_project_info

edgeimpulse_api.api.projects_api.get_project_info(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		impulse_id: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Impulse ID. If this is unset then the default impulse is used.', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.project_info_response.ProjectInfoResponse

Project information

List all information about this project.

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• impulse_id: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Impulse ID. If this is unset then the default impulse is used.', extra={})] = None

• **kwargs

Return

edgeimpulse_api.models.project_info_response.ProjectInfoResponse

get_project_info_summary

edgeimpulse_api.api.projects_api.get_project_info_summary(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.project_info_summary_response.ProjectInfoSummaryResponse

Public project information

List a summary about this project - available for public projects.

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.project_info_summary_response.ProjectInfoSummaryResponse

get_project_last_modification_date

edgeimpulse_api.api.projects_api.get_project_last_modification_date(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.last_modification_date_response.LastModificationDateResponse

Last modification

Get the last modification date for a project (will be upped when data is modified, or when an impulse is trained)

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.last_modification_date_response.LastModificationDateResponse

get_project_recommended_data_interval

edgeimpulse_api.api.projects_api.get_project_recommended_data_interval(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.project_data_interval_response.ProjectDataIntervalResponse

Get the interval (in ms) of the training data

Get the interval of the training data; if multiple intervals are present, the interval of the longest data item is returned.

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.project_data_interval_response.ProjectDataIntervalResponse

get_project_training_data_summary

edgeimpulse_api.api.projects_api.get_project_training_data_summary(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		include_disabled: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description='Whether to include disabled samples. Defaults to true', extra={})] = None,
		include_not_processed: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description='Whether to include non-processed samples. Defaults to true', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.project_training_data_summary_response.ProjectTrainingDataSummaryResponse

Get data summary

Get summary of all data present in the training set. This returns the number of data items, the total length of all data, and the labels. This is similar to dataSummary in ProjectInfoResponse but allows you to exclude disabled items or items that are still processing.

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• include_disabled: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description='Whether to include disabled samples. Defaults to true', extra={})] = None

• include_not_processed: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description='Whether to include non-processed samples. Defaults to true', extra={})] = None

• **kwargs

Return

edgeimpulse_api.models.project_training_data_summary_response.ProjectTrainingDataSummaryResponse

get_socket_token

edgeimpulse_api.api.projects_api.get_socket_token(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.socket_token_response.SocketTokenResponse

Get socket token

Get a token to authenticate with the web socket interface.

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.socket_token_response.SocketTokenResponse

get_synthetic_data_config

edgeimpulse_api.api.projects_api.get_synthetic_data_config(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.get_synthetic_data_config_response.GetSyntheticDataConfigResponse

Get synthetic data config

Get the last used synthetic data config

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.get_synthetic_data_config_response.GetSyntheticDataConfigResponse

get_target_constraints

edgeimpulse_api.api.projects_api.get_target_constraints(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.get_target_constraints_response.GetTargetConstraintsResponse

Get target constraints

Retrieve target constraints for a project. The constraints object captures hardware attributes of your target device, along with an application budget to allow guidance on performance and resource usage

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.get_target_constraints_response.GetTargetConstraintsResponse

launch_getting_started_wizard

edgeimpulse_api.api.projects_api.launch_getting_started_wizard(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Launch getting started wizard

This clears out all data in your project, and is irrevocable. This function is only available through a JWT token, and is not available to all users.

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

list_ai_actions

edgeimpulse_api.api.projects_api.list_ai_actions(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.list_ai_actions_response.ListAIActionsResponse

List AI Actions

Get all AI actions.

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.list_ai_actions_response.ListAIActionsResponse

list_development_boards

edgeimpulse_api.api.projects_api.list_development_boards(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.development_boards_response.DevelopmentBoardsResponse

Development boards

List all development boards for a project

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.development_boards_response.DevelopmentBoardsResponse

list_devkeys

edgeimpulse_api.api.projects_api.list_devkeys(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.development_keys_response.DevelopmentKeysResponse

Get development keys

Retrieve the development API and HMAC keys for a project. These keys are specifically marked to be used during development. These keys can be undefined if no development keys are set.

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.development_keys_response.DevelopmentKeysResponse

list_downloads

edgeimpulse_api.api.projects_api.list_downloads(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		impulse_id: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Impulse ID. If this is unset then the default impulse is used.', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.project_downloads_response.ProjectDownloadsResponse

Get downloads

Retrieve the downloads for a project.

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• impulse_id: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Impulse ID. If this is unset then the default impulse is used.', extra={})] = None

• **kwargs

Return

edgeimpulse_api.models.project_downloads_response.ProjectDownloadsResponse

list_emails

edgeimpulse_api.api.projects_api.list_emails(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.list_email_response.ListEmailResponse

List emails

Get a list of all emails sent by Edge Impulse regarding this project.

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.list_email_response.ListEmailResponse

list_project_api_keys

edgeimpulse_api.api.projects_api.list_project_api_keys(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.list_api_keys_response.ListApiKeysResponse

Get API keys

Retrieve all API keys. This does not return the full API key, but only a portion (for security purposes). The development key will be returned in full, as it'll be set in devices and is thus not private.

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.list_api_keys_response.ListApiKeysResponse

list_project_hmac_keys

edgeimpulse_api.api.projects_api.list_project_hmac_keys(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.list_hmac_keys_response.ListHmacKeysResponse

Get HMAC keys

Retrieve all HMAC keys.

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.list_hmac_keys_response.ListHmacKeysResponse

list_projects

edgeimpulse_api.api.projects_api.list_projects(
		self,
		**kwargs
) ‑> edgeimpulse_api.models.list_projects_response.ListProjectsResponse

List active projects

Retrieve list of active projects. If authenticating using JWT token this lists all the projects the user has access to, if authenticating using an API key, this only lists that project.

Parameters

• self

• **kwargs

Return

edgeimpulse_api.models.list_projects_response.ListProjectsResponse

list_public_project_types

edgeimpulse_api.api.projects_api.list_public_project_types(
		self,
		**kwargs
) ‑> edgeimpulse_api.models.list_public_project_types_response.ListPublicProjectTypesResponse

List public project types

Retrieve the list of available public project types. You don't need any authentication for this method.

Parameters

• self

• **kwargs

Return

edgeimpulse_api.models.list_public_project_types_response.ListPublicProjectTypesResponse

list_public_projects

edgeimpulse_api.api.projects_api.list_public_projects(
		self,
		limit: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None,
		offset: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None,
		project: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='Only include projects where the name or owner contains this string', extra={})] = None,
		project_types: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description="Comma separated list of project types to filter on. Supported values are 'audio', 'object-detection', 'image', 'accelerometer', 'other'.", extra={})] = None,
		sort: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='Fields and order to sort query by', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.list_public_projects_response.ListPublicProjectsResponse

List public projects

Retrieve the list of all public projects. You don't need any authentication for this method.

Parameters

• self

• limit: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None

• offset: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None

• project: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='Only include projects where the name or owner contains this string', extra={})] = None

• project_types: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description="Comma separated list of project types to filter on. Supported values are 'audio', 'object-detection', 'image', 'accelerometer', 'other'.", extra={})] = None

• sort: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='Fields and order to sort query by', extra={})] = None

• **kwargs

Return

edgeimpulse_api.models.list_public_projects_response.ListPublicProjectsResponse

list_public_versions

edgeimpulse_api.api.projects_api.list_public_versions(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.list_public_versions_response.ListPublicVersionsResponse

List public versions

Get all public versions for this project. You don't need any authentication for this function.

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.list_public_versions_response.ListPublicVersionsResponse

list_versions

edgeimpulse_api.api.projects_api.list_versions(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.list_versions_response.ListVersionsResponse

List versions

Get all versions for this project.

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.list_versions_response.ListVersionsResponse

make_version_private

edgeimpulse_api.api.projects_api.make_version_private(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		version_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Version ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Make version private

Make a public version private.

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• version_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Version ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

preview_ai_actions_samples

edgeimpulse_api.api.projects_api.preview_ai_actions_samples(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		action_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='AI Action ID', extra={})],
		preview_ai_actions_samples_request: edgeimpulse_api.models.preview_ai_actions_samples_request.PreviewAIActionsSamplesRequest,
		**kwargs
) ‑> edgeimpulse_api.models.list_samples_response.ListSamplesResponse

Preview samples for AI Actions

Get a number of random samples to show in the AI Actions screen. If saveConfig is passed in, then a valid actionId is required in the URL. If you don't need to save the config (e.g. when creating a new action), you can use -1.

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• action_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='AI Action ID', extra={})]

• preview_ai_actions_samples_request: edgeimpulse_api.models.preview_ai_actions_samples_request.PreviewAIActionsSamplesRequest

• **kwargs

Return

edgeimpulse_api.models.list_samples_response.ListSamplesResponse

project_dismiss_notification

edgeimpulse_api.api.projects_api.project_dismiss_notification(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		project_dismiss_notification_request: edgeimpulse_api.models.project_dismiss_notification_request.ProjectDismissNotificationRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Dismiss a notification

Dismiss a notification

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• project_dismiss_notification_request: edgeimpulse_api.models.project_dismiss_notification_request.ProjectDismissNotificationRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

remove_collaborator

edgeimpulse_api.api.projects_api.remove_collaborator(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		remove_collaborator_request: edgeimpulse_api.models.remove_collaborator_request.RemoveCollaboratorRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Remove collaborator

Remove a collaborator to a project. Note that you cannot invoke this function if only a single collaborator is present.

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• remove_collaborator_request: edgeimpulse_api.models.remove_collaborator_request.RemoveCollaboratorRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

revoke_project_api_key

edgeimpulse_api.api.projects_api.revoke_project_api_key(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		api_key_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='API key ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Revoke API key

Revoke an API key. Note that if you revoke the development API key some services (such as automatic provisioning of devices through the serial daemon) will no longer work.

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• api_key_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='API key ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

revoke_project_hmac_key

edgeimpulse_api.api.projects_api.revoke_project_hmac_key(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		hmac_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Hmac key ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Remove HMAC key

Revoke an HMAC key. Note that if you revoke the development key some services (such as automatic provisioning of devices through the serial daemon) will no longer work.

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• hmac_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Hmac key ID', extra={})]

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

set_ai_actions_order

edgeimpulse_api.api.projects_api.set_ai_actions_order(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		set_ai_actions_order_request: edgeimpulse_api.models.set_ai_actions_order_request.SetAIActionsOrderRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Set AI Actions order

Change the order of AI actions. Post the new order of all AI Actions by ID. You need to specify all AI Actions here. If not, an error will be thrown.

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• set_ai_actions_order_request: edgeimpulse_api.models.set_ai_actions_order_request.SetAIActionsOrderRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

set_project_compute_time_limit

edgeimpulse_api.api.projects_api.set_project_compute_time_limit(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		set_project_compute_time_request: edgeimpulse_api.models.set_project_compute_time_request.SetProjectComputeTimeRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Set compute time limit

Change the job compute time limit for the project. This function is only available through a JWT token, and is not available to all users.

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• set_project_compute_time_request: edgeimpulse_api.models.set_project_compute_time_request.SetProjectComputeTimeRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

set_project_file_size_limit

edgeimpulse_api.api.projects_api.set_project_file_size_limit(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		set_project_dsp_file_size_request: edgeimpulse_api.models.set_project_dsp_file_size_request.SetProjectDspFileSizeRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Set DSP file size limit

Change the DSP file size limit for the project. This function is only available through a JWT token, and is not available to all users.

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• set_project_dsp_file_size_request: edgeimpulse_api.models.set_project_dsp_file_size_request.SetProjectDspFileSizeRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

set_target_constraints

edgeimpulse_api.api.projects_api.set_target_constraints(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		target_constraints: edgeimpulse_api.models.target_constraints.TargetConstraints,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Set target constraints

Set target constraints for a project. Use the constraints object to capture hardware attributes of your target device, along with an application budget to allow guidance on performance and resource usage

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• target_constraints: edgeimpulse_api.models.target_constraints.TargetConstraints

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

transfer_ownership

edgeimpulse_api.api.projects_api.transfer_ownership(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		add_collaborator_request: edgeimpulse_api.models.add_collaborator_request.AddCollaboratorRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Transfer ownership (user)

Transfer ownership of a project to another user.

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• add_collaborator_request: edgeimpulse_api.models.add_collaborator_request.AddCollaboratorRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

transfer_ownership_organization

edgeimpulse_api.api.projects_api.transfer_ownership_organization(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		transfer_ownership_organization_request: edgeimpulse_api.models.transfer_ownership_organization_request.TransferOwnershipOrganizationRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Transfer ownership (organization)

Transfer ownership of a project to another organization.

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• transfer_ownership_organization_request: edgeimpulse_api.models.transfer_ownership_organization_request.TransferOwnershipOrganizationRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

update_ai_action

edgeimpulse_api.api.projects_api.update_ai_action(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		action_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='AI Action ID', extra={})],
		update_ai_action_request: edgeimpulse_api.models.update_ai_action_request.UpdateAIActionRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Save AI Actions config

Store an AI Actions config. Use createAIActionsJob to run the job. Post the full AI Action here w/ all parameters.

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• action_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='AI Action ID', extra={})]

• update_ai_action_request: edgeimpulse_api.models.update_ai_action_request.UpdateAIActionRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

update_project

edgeimpulse_api.api.projects_api.update_project(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		update_project_request: edgeimpulse_api.models.update_project_request.UpdateProjectRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Update project

Update project properties such as name and logo.

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• update_project_request: edgeimpulse_api.models.update_project_request.UpdateProjectRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

update_project_tags

edgeimpulse_api.api.projects_api.update_project_tags(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		update_project_tags_request: edgeimpulse_api.models.update_project_tags_request.UpdateProjectTagsRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Update tags

Update the list of project tags.

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• update_project_tags_request: edgeimpulse_api.models.update_project_tags_request.UpdateProjectTagsRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

update_version

edgeimpulse_api.api.projects_api.update_version(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		version_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Version ID', extra={})],
		update_version_request: edgeimpulse_api.models.update_version_request.UpdateVersionRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Update version

Updates a version, this only updates fields that were set in the body.

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• version_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Version ID', extra={})]

• update_version_request: edgeimpulse_api.models.update_version_request.UpdateVersionRequest

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

upload_csv_wizard_uploaded_file

edgeimpulse_api.api.projects_api.upload_csv_wizard_uploaded_file(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		file: pydantic.types.StrictStr,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Store CSV Wizard uploaded file

Asynchronously called in the CSV Wizard to store the file that the CSV wizard was based on.

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• file: pydantic.types.StrictStr

• **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

upload_readme_image

edgeimpulse_api.api.projects_api.upload_readme_image(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		image: pydantic.types.StrictStr,
		**kwargs
) ‑> edgeimpulse_api.models.upload_readme_image_response.UploadReadmeImageResponse

Upload image for readme

Uploads an image to the user CDN and returns the path.

Parameters

• self

• project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]

• image: pydantic.types.StrictStr

• **kwargs

Return

edgeimpulse_api.models.upload_readme_image_response.UploadReadmeImageResponse