Classes
ProjectsApi
| Parameters | |
|---|---|
api_client=None | |
METHODS
add_collaborator
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
add_collaborator_request | edgeimpulse_api.models.add_collaborator_request.AddCollaboratorRequest |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.entity_created_response.EntityCreatedResponse |
add_project_api_key
developmentKey to true this flag will be removed from the current development API key.
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
add_project_api_key_request | edgeimpulse_api.models.add_project_api_key_request.AddProjectApiKeyRequest |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.add_api_key_response.AddApiKeyResponse |
add_project_hmac_key
developmentKey to true this flag will be removed from the current development HMAC key.
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
add_hmac_key_request | edgeimpulse_api.models.add_hmac_key_request.AddHmacKeyRequest |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.entity_created_response.EntityCreatedResponse |
clear_ai_actions_proposed_changes
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
action_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='AI Action ID')] |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
create_ai_action
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.entity_created_response.EntityCreatedResponse |
create_project
| Parameters | |
|---|---|
self | |
create_project_request | edgeimpulse_api.models.create_project_request.CreateProjectRequest |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.create_project_response.CreateProjectResponse |
delete_ai_action
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
action_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='AI Action ID')] |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
delete_project
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
delete_version
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
version_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Version ID')] |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
download_csv_wizard_config
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
**kwargs | |
| Returns |
|---|
str |
download_csv_wizard_uploaded_file
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
**kwargs | |
| Returns |
|---|
str |
get_ai_action
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
action_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='AI Action ID')] |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.get_ai_action_response.GetAIActionResponse |
get_csv_wizard_uploaded_file_info
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.get_csv_wizard_uploaded_file_info.GetCsvWizardUploadedFileInfo |
get_model_variants
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
impulse_id | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Impulse ID. If this is unset then the default impulse is used.')] = None |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.get_model_variants_response.GetModelVariantsResponse |
get_new_ai_action
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.get_ai_action_response.GetAIActionResponse |
get_project_data_axes_summary
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
include_disabled | Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Whether to include disabled samples. Defaults to true')] = None |
include_not_processed | Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Whether to include non-processed samples. Defaults to true')] = None |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.project_data_axes_summary_response.ProjectDataAxesSummaryResponse |
get_project_info
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
impulse_id | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Impulse ID. If this is unset then the default impulse is used.')] = None |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.project_info_response.ProjectInfoResponse |
get_project_info_summary
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.project_info_summary_response.ProjectInfoSummaryResponse |
get_project_last_modification_date
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.last_modification_date_response.LastModificationDateResponse |
get_project_recommended_data_interval
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.project_data_interval_response.ProjectDataIntervalResponse |
get_project_training_data_summary
dataSummary in ProjectInfoResponse but allows you to exclude disabled items or items that are still processing.
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
include_disabled | Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Whether to include disabled samples. Defaults to true')] = None |
include_not_processed | Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Whether to include non-processed samples. Defaults to true')] = None |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.project_training_data_summary_response.ProjectTrainingDataSummaryResponse |
get_socket_token
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.socket_token_response.SocketTokenResponse |
get_synthetic_data_config
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.get_synthetic_data_config_response.GetSyntheticDataConfigResponse |
get_target_constraints
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.get_target_constraints_response.GetTargetConstraintsResponse |
launch_getting_started_wizard
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
list_ai_actions
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.list_ai_actions_response.ListAIActionsResponse |
list_development_boards
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.development_boards_response.DevelopmentBoardsResponse |
list_devkeys
undefined if no development keys are set. Only available through JWT token authentication, if you authenticate with an API key then all keys will return undefined (this is changed behavior since 28 January 2026).
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.development_keys_response.DevelopmentKeysResponse |
list_downloads
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
impulse_id | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Impulse ID. If this is unset then the default impulse is used.')] = None |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.project_downloads_response.ProjectDownloadsResponse |
list_emails
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.list_email_response.ListEmailResponse |
list_project_api_keys
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.list_api_keys_response.ListApiKeysResponse |
list_project_hmac_keys
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.list_hmac_keys_response.ListHmacKeysResponse |
list_projects
| Parameters | |
|---|---|
self | |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.list_projects_response.ListProjectsResponse |
list_public_project_types
| Parameters | |
|---|---|
self | |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.list_public_project_types_response.ListPublicProjectTypesResponse |
list_public_projects
| Parameters | |
|---|---|
self | |
limit | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Maximum number of results')] = None |
offset | Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.')] = None |
project | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Only include projects where the name or owner contains this string')] = None |
project_types | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="Comma separated list of project types to filter on. Supported values are 'audio', 'object-detection', 'image', 'accelerometer', 'other'.")] = None |
sort | Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Fields and order to sort query by')] = None |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.list_public_projects_response.ListPublicProjectsResponse |
list_public_versions
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.list_public_versions_response.ListPublicVersionsResponse |
list_versions
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.list_versions_response.ListVersionsResponse |
make_version_private
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
version_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Version ID')] |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
preview_ai_actions_samples
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[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
action_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='AI Action ID')] |
preview_ai_actions_samples_request | edgeimpulse_api.models.preview_ai_actions_samples_request.PreviewAIActionsSamplesRequest |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.list_samples_response.ListSamplesResponse |
project_dismiss_notification
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
project_dismiss_notification_request | edgeimpulse_api.models.project_dismiss_notification_request.ProjectDismissNotificationRequest |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
remove_collaborator
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
remove_collaborator_request | edgeimpulse_api.models.remove_collaborator_request.RemoveCollaboratorRequest |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
revoke_project_api_key
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
api_key_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='API key ID')] |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
revoke_project_hmac_key
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
hmac_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Hmac key ID')] |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
set_ai_actions_order
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
set_ai_actions_order_request | edgeimpulse_api.models.set_ai_actions_order_request.SetAIActionsOrderRequest |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
set_project_compute_time_limit
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
set_project_compute_time_request | edgeimpulse_api.models.set_project_compute_time_request.SetProjectComputeTimeRequest |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
set_project_file_size_limit
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
set_project_dsp_file_size_request | edgeimpulse_api.models.set_project_dsp_file_size_request.SetProjectDspFileSizeRequest |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
set_target_constraints
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
target_constraints | edgeimpulse_api.models.target_constraints.TargetConstraints |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
transfer_ownership
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
add_collaborator_request | edgeimpulse_api.models.add_collaborator_request.AddCollaboratorRequest |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
transfer_ownership_organization
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
transfer_ownership_organization_request | edgeimpulse_api.models.transfer_ownership_organization_request.TransferOwnershipOrganizationRequest |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
update_ai_action
createAIActionsJob to run the job. Post the full AI Action here w/ all parameters.
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
action_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='AI Action ID')] |
update_ai_action_request | edgeimpulse_api.models.update_ai_action_request.UpdateAIActionRequest |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
update_project
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
update_project_request | edgeimpulse_api.models.update_project_request.UpdateProjectRequest |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
update_project_tags
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
update_project_tags_request | edgeimpulse_api.models.update_project_tags_request.UpdateProjectTagsRequest |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
update_version
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
version_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Version ID')] |
update_version_request | edgeimpulse_api.models.update_version_request.UpdateVersionRequest |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
upload_csv_wizard_uploaded_file
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
file | Annotated[str, Strict(strict=True)] |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.generic_api_response.GenericApiResponse |
upload_readme_image
| Parameters | |
|---|---|
self | |
project_id | Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='Project ID')] |
image | Annotated[str, Strict(strict=True)] |
**kwargs | |
| Returns |
|---|
edgeimpulse_api.models.upload_readme_image_response.UploadReadmeImageResponse |