Parameters
api_client=None
Add collaborator
Add a collaborator to a project.
Parameters
self
project_id: typing_extensions.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
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: typing_extensions.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.generic_api_response.GenericApiResponse
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: typing_extensions.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.generic_api_response.GenericApiResponse
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
Remove project
Remove the current project, and all data associated with it. This is irrevocable!
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
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: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
version_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Version ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
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: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
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: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
str
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: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_csv_wizard_uploaded_file_info.GetCsvWizardUploadedFileInfo
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: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_model_variants_response.GetModelVariantsResponse
Get notes
Get all notes in project.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.get_notes_response.GetNotesResponse
Get data axes summary
Get a list of axes that are present in the training data.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
include_disabled: typing_extensions.Annotated[Optional[pydantic.types.StrictBool], FieldInfo(default=PydanticUndefined, description='Whether to include disabled samples. Defaults to true', extra={})] = None
include_not_processed: typing_extensions.Annotated[Optional[pydantic.types.StrictBool], 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
Project information
List all information about this project.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.project_info_response.ProjectInfoResponse
Public project information
List a summary about this project - available for public projects.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.project_info_summary_response.ProjectInfoSummaryResponse
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: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.last_modification_date_response.LastModificationDateResponse
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: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.project_data_interval_response.ProjectDataIntervalResponse
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: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
include_disabled: typing_extensions.Annotated[Optional[pydantic.types.StrictBool], FieldInfo(default=PydanticUndefined, description='Whether to include disabled samples. Defaults to true', extra={})] = None
include_not_processed: typing_extensions.Annotated[Optional[pydantic.types.StrictBool], 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
Get a token to authenticate with the web socket interface.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.socket_token_response.SocketTokenResponse
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: typing_extensions.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
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: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Development boards
List all development boards for a project
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.development_boards_response.DevelopmentBoardsResponse
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: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.development_keys_response.DevelopmentKeysResponse
Get downloads
Retrieve the downloads for a project.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.project_downloads_response.ProjectDownloadsResponse
List emails
Get a list of all emails sent by Edge Impulse regarding this project.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.list_email_response.ListEmailResponse
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: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.list_api_keys_response.ListApiKeysResponse
Get HMAC keys
Retrieve all HMAC keys.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.list_hmac_keys_response.ListHmacKeysResponse
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 projects
Retrieve the list of all public projects. You don't need any authentication for this method.
Parameters
self
limit: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None
offset: typing_extensions.Annotated[Optional[pydantic.types.StrictInt], FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None
project: typing_extensions.Annotated[Optional[pydantic.types.StrictStr], FieldInfo(default=PydanticUndefined, description='Only include projects that contain this string', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.list_public_projects_response.ListPublicProjectsResponse
List public versions
Get all public versions for this project. You don't need any authentication for this function.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.list_public_versions_response.ListPublicVersionsResponse
List versions
Get all versions for this project.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.list_versions_response.ListVersionsResponse
Make version private
Make a public version private.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
version_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Version ID', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
Dismiss a notification
Dismiss a notification
Parameters
self
project_id: typing_extensions.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
Remove a collaborator to a project. Note that you cannot invoke this function if only a single collaborator is present.
Parameters
self
project_id: typing_extensions.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 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: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
api_key_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='API key ID', extra={})]
**kwargs
Return
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: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
hmac_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Hmac key ID', extra={})]
**kwargs
Return
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: typing_extensions.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 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: typing_extensions.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
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: typing_extensions.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 (user)
Transfer ownership of a project to another user.
Parameters
self
project_id: typing_extensions.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)
Transfer ownership of a project to another organization.
Parameters
self
project_id: typing_extensions.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 project
Update project properties such as name and logo.
Parameters
self
project_id: typing_extensions.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 tags
Update the list of project tags.
Parameters
self
project_id: typing_extensions.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
Updates a version, this only updates fields that were set in the body.
Parameters
self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
version_id: typing_extensions.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
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: typing_extensions.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 image for readme
Uploads an image to the user CDN and returns the path.
Parameters
self
project_id: typing_extensions.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