projects_api
edgeimpulse_api v1.0.0
edgeimpulse_api.api.projects_api module
class edgeimpulse_api.api.projects_api.ProjectsApi(api_client=None)Bases:
object
add_collaborator(project_id: StrictInt, add_collaborator_request: AddCollaboratorRequest, **kwargs)Add collaborator
Add a collaborator to a project.
Parameters
project_id (int) – Project ID (required)
add_collaborator_request (AddCollaboratorRequest) – (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
add_project_api_key(project_id: StrictInt, add_api_key_request: AddApiKeyRequest, **kwargs)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
project_id (int) – Project ID (required)
add_api_key_request (AddApiKeyRequest) – (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
add_project_hmac_key(project_id: StrictInt, add_hmac_key_request: AddHmacKeyRequest, **kwargs)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
project_id (int) – Project ID (required)
add_hmac_key_request (AddHmacKeyRequest) – (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
create_project(create_project_request: CreateProjectRequest, **kwargs)Create new project
Create a new project. This API can only be called using a JWT token.
Parameters
create_project_request (CreateProjectRequest) – (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
delete_project(project_id: StrictInt, **kwargs)Remove project
Remove the current project, and all data associated with it. This is irrevocable!
Parameters
project_id (int) – Project ID (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
delete_version(project_id: StrictInt, version_id: StrictInt, **kwargs)Delete versions
Delete a version. This does not delete the version from cold storage.
Parameters
project_id (int) – Project ID (required)
version_id (int) – Version ID (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
get_notes(project_id: StrictInt, **kwargs)Get notes
Get all notes in project.
Parameters
project_id (int) – Project ID (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
get_project_data_axes_summary(project_id: StrictInt, include_disabled: Optional[StrictBool] = None, include_not_processed: Optional[StrictBool] = None, **kwargs)Get data axes summary
Get a list of axes that are present in the training data.
Parameters
project_id (int) – Project ID (required)
include_disabled (bool) – Whether to include disabled samples. Defaults to true
include_not_processed (bool) – Whether to include non-processed samples. Defaults to true
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
get_project_info(project_id: StrictInt, **kwargs)Project information
List all information about this project.
Parameters
project_id (int) – Project ID (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
get_project_info_summary(project_id: StrictInt, **kwargs)Public project information
List a summary about this project - available for public projects.
Parameters
project_id (int) – Project ID (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
get_project_last_modification_date(project_id: StrictInt, **kwargs)Last modification
Get the last modification date for a project (will be upped when data is modified, or when an impulse is trained)
Parameters
project_id (int) – Project ID (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
get_project_recommended_data_interval(project_id: StrictInt, **kwargs)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
project_id (int) – Project ID (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
get_socket_token(project_id: StrictInt, **kwargs)Get socket token
Get a token to authenticate with the web socket interface.
Parameters
project_id (int) – Project ID (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
launch_getting_started_wizard(project_id: StrictInt, **kwargs)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
project_id (int) – Project ID (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
list_development_boards(project_id: StrictInt, **kwargs)Development boards
List all development boards for a project
Parameters
project_id (int) – Project ID (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
list_devkeys(project_id: StrictInt, **kwargs)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
project_id (int) – Project ID (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
list_downloads(project_id: StrictInt, **kwargs)Get downloads
Retrieve the downloads for a project.
Parameters
project_id (int) – Project ID (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
list_emails(project_id: StrictInt, **kwargs)List emails
Get a list of all emails sent by Edge Impulse regarding this project.
Parameters
project_id (int) – Project ID (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
list_project_api_keys(project_id: StrictInt, **kwargs)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
project_id (int) – Project ID (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
list_project_hmac_keys(project_id: StrictInt, **kwargs)Get HMAC keys
Retrieve all HMAC keys.
Parameters
project_id (int) – Project ID (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
list_projects(**kwargs)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
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
list_public_projects(limit: Optional[StrictInt] = None, offset: Optional[StrictInt] = None, project: Optional[StrictStr] = None, **kwargs)List public projects
Retrieve the list of all public projects. You don’t need any authentication for this method.
Parameters
limit (int) – Maximum number of results
offset (int) – Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
project (str) – Only include projects that contain this string
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
list_public_versions(project_id: StrictInt, **kwargs)List public versions
Get all public versions for this project. You don’t need any authentication for this function.
Parameters
project_id (int) – Project ID (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
list_versions(project_id: StrictInt, **kwargs)List versions
Get all versions for this project.
Parameters
project_id (int) – Project ID (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
make_version_private(project_id: StrictInt, version_id: StrictInt, **kwargs)Make version private
Make a public version private.
Parameters
project_id (int) – Project ID (required)
version_id (int) – Version ID (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
remove_collaborator(project_id: StrictInt, remove_collaborator_request: RemoveCollaboratorRequest, **kwargs)Remove collaborator
Remove a collaborator to a project. Note that you cannot invoke this function if only a single collaborator is present.
Parameters
project_id (int) – Project ID (required)
remove_collaborator_request (RemoveCollaboratorRequest) – (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
revoke_project_api_key(project_id: StrictInt, api_key_id: StrictInt, **kwargs)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
project_id (int) – Project ID (required)
api_key_id (int) – API key ID (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
revoke_project_hmac_key(project_id: StrictInt, hmac_id: StrictInt, **kwargs)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
project_id (int) – Project ID (required)
hmac_id (int) – Hmac key ID (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
set_project_compute_time_limit(project_id: StrictInt, set_project_compute_time_request: SetProjectComputeTimeRequest, **kwargs)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
project_id (int) – Project ID (required)
set_project_compute_time_request (SetProjectComputeTimeRequest) – (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
set_project_file_size_limit(project_id: StrictInt, set_project_dsp_file_size_request: SetProjectDspFileSizeRequest, **kwargs)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
project_id (int) – Project ID (required)
set_project_dsp_file_size_request (SetProjectDspFileSizeRequest) – (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
transfer_ownership(project_id: StrictInt, add_collaborator_request: AddCollaboratorRequest, **kwargs)Transfer ownership (user)
Transfer ownership of a project to another user.
Parameters
project_id (int) – Project ID (required)
add_collaborator_request (AddCollaboratorRequest) – (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
transfer_ownership_organization(project_id: StrictInt, transfer_ownership_organization_request: TransferOwnershipOrganizationRequest, **kwargs)Transfer ownership (organization)
Transfer ownership of a project to another organization.
Parameters
project_id (int) – Project ID (required)
transfer_ownership_organization_request (TransferOwnershipOrganizationRequest) – (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
update_project(project_id: StrictInt, update_project_request: UpdateProjectRequest, **kwargs)Update project
Update project properties such as name and logo.
Parameters
project_id (int) – Project ID (required)
update_project_request (UpdateProjectRequest) – (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
update_project_tags(project_id: StrictInt, update_project_tags_request: UpdateProjectTagsRequest, **kwargs)Update tags
Update the list of project tags.
Parameters
project_id (int) – Project ID (required)
update_project_tags_request (UpdateProjectTagsRequest) – (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
update_version(project_id: StrictInt, version_id: StrictInt, update_version_request: UpdateVersionRequest, **kwargs)Update version
Updates a version, this only updates fields that were set in the body.
Parameters
project_id (int) – Project ID (required)
version_id (int) – Version ID (required)
update_version_request (UpdateVersionRequest) – (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
upload_readme_image(project_id: StrictInt, image: StrictStr, **kwargs)Upload image for readme
Uploads an image to the user CDN and returns the path.
Parameters
project_id (int) – Project ID (required)
image (str) – (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
Last updated
Was this helpful?