projects_api module#

class edgeimpulse_api.api.projects_api.ProjectsApi(api_client=None)[source]#

Bases: object

add_collaborator(

project_id: StrictInt[StrictInt],

add_collaborator_request: AddCollaboratorRequest,

**kwargs,

) → GenericApiResponse[source]#

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:

GenericApiResponse

add_project_api_key(

project_id: StrictInt[StrictInt],

add_project_api_key_request: AddProjectApiKeyRequest,

**kwargs,

) → GenericApiResponse[source]#

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_project_api_key_request (AddProjectApiKeyRequest) – (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:

GenericApiResponse

add_project_hmac_key(

project_id: StrictInt[StrictInt],

add_hmac_key_request: AddHmacKeyRequest,

**kwargs,

) → GenericApiResponse[source]#

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:

GenericApiResponse

create_project(

create_project_request: CreateProjectRequest,

**kwargs,

) → CreateProjectResponse[source]#

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:

CreateProjectResponse

delete_project(

project_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

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:

GenericApiResponse

delete_version(

project_id: StrictInt[StrictInt],

version_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

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:

GenericApiResponse

download_csv_wizard_config(

project_id: StrictInt[StrictInt],

**kwargs,

) → str[source]#

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:

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:

str

download_csv_wizard_uploaded_file(

project_id: StrictInt[StrictInt],

**kwargs,

) → str[source]#

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:

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:

str

get_csv_wizard_uploaded_file_info(

project_id: StrictInt[StrictInt],

**kwargs,

) → GetCsvWizardUploadedFileInfo[source]#

Get CSV Wizard uploaded file info

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

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:

GetCsvWizardUploadedFileInfo

get_notes(

project_id: StrictInt[StrictInt],

**kwargs,

) → GetNotesResponse[source]#

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:

GetNotesResponse

get_project_data_axes_summary(

project_id: StrictInt[StrictInt],

include_disabled: StrictBool | None[StrictBool | None] = None,

include_not_processed: StrictBool | None[StrictBool | None] = None,

**kwargs,

) → ProjectDataAxesSummaryResponse[source]#

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:

ProjectDataAxesSummaryResponse

get_project_info(

project_id: StrictInt[StrictInt],

**kwargs,

) → ProjectInfoResponse[source]#

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:

ProjectInfoResponse

get_project_info_summary(

project_id: StrictInt[StrictInt],

**kwargs,

) → ProjectInfoSummaryResponse[source]#

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:

ProjectInfoSummaryResponse

get_project_last_modification_date(

project_id: StrictInt[StrictInt],

**kwargs,

) → LastModificationDateResponse[source]#

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:

LastModificationDateResponse

get_project_recommended_data_interval(

project_id: StrictInt[StrictInt],

**kwargs,

) → ProjectDataIntervalResponse[source]#

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:

ProjectDataIntervalResponse

get_project_training_data_summary(

project_id: StrictInt[StrictInt],

include_disabled: StrictBool | None[StrictBool | None] = None,

include_not_processed: StrictBool | None[StrictBool | None] = None,

**kwargs,

) → ProjectTrainingDataSummaryResponse[source]#

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:

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:

ProjectTrainingDataSummaryResponse

get_socket_token(

project_id: StrictInt[StrictInt],

**kwargs,

) → SocketTokenResponse[source]#

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:

SocketTokenResponse

get_target_constraints(

project_id: StrictInt[StrictInt],

**kwargs,

) → GetTargetConstraintsResponse[source]#

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:

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:

GetTargetConstraintsResponse

launch_getting_started_wizard(

project_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

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:

GenericApiResponse

list_development_boards(

project_id: StrictInt[StrictInt],

**kwargs,

) → DevelopmentBoardsResponse[source]#

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:

DevelopmentBoardsResponse

list_devkeys(

project_id: StrictInt[StrictInt],

**kwargs,

) → DevelopmentKeysResponse[source]#

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:

DevelopmentKeysResponse

list_downloads(

project_id: StrictInt[StrictInt],

**kwargs,

) → ProjectDownloadsResponse[source]#

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:

ProjectDownloadsResponse

list_emails(

project_id: StrictInt[StrictInt],

**kwargs,

) → ListEmailResponse[source]#

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:

ListEmailResponse

list_project_api_keys(

project_id: StrictInt[StrictInt],

**kwargs,

) → ListApiKeysResponse[source]#

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:

ListApiKeysResponse

list_project_hmac_keys(

project_id: StrictInt[StrictInt],

**kwargs,

) → ListHmacKeysResponse[source]#

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:

ListHmacKeysResponse

list_projects(

**kwargs,

) → ListProjectsResponse[source]#

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:

ListProjectsResponse

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:

ListPublicProjectsResponse

list_public_versions(

project_id: StrictInt[StrictInt],

**kwargs,

) → ListPublicVersionsResponse[source]#

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:

ListPublicVersionsResponse

list_versions(

project_id: StrictInt[StrictInt],

**kwargs,

) → ListVersionsResponse[source]#

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:

ListVersionsResponse

make_version_private(

project_id: StrictInt[StrictInt],

version_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

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:

GenericApiResponse

project_dismiss_notification(

project_id: StrictInt[StrictInt],

project_dismiss_notification_request: ProjectDismissNotificationRequest,

**kwargs,

) → GenericApiResponse[source]#

Dismiss a notification

Parameters:

project_id (int) – Project ID (required)
project_dismiss_notification_request (ProjectDismissNotificationRequest) – (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:

GenericApiResponse

remove_collaborator(

project_id: StrictInt[StrictInt],

remove_collaborator_request: RemoveCollaboratorRequest,

**kwargs,

) → GenericApiResponse[source]#

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:

GenericApiResponse

revoke_project_api_key(

project_id: StrictInt[StrictInt],

api_key_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

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:

GenericApiResponse

revoke_project_hmac_key(

project_id: StrictInt[StrictInt],

hmac_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

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:

GenericApiResponse

set_project_compute_time_limit(

project_id: StrictInt[StrictInt],

set_project_compute_time_request: SetProjectComputeTimeRequest,

**kwargs,

) → GenericApiResponse[source]#

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:

GenericApiResponse

set_project_file_size_limit(

project_id: StrictInt[StrictInt],

set_project_dsp_file_size_request: SetProjectDspFileSizeRequest,

**kwargs,

) → GenericApiResponse[source]#

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:

GenericApiResponse

set_target_constraints(

project_id: StrictInt[StrictInt],

target_constraints: TargetConstraints,

**kwargs,

) → GenericApiResponse[source]#

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:

project_id (int) – Project ID (required)
target_constraints (TargetConstraints) – (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:

GenericApiResponse

transfer_ownership(

project_id: StrictInt[StrictInt],

add_collaborator_request: AddCollaboratorRequest,

**kwargs,

) → GenericApiResponse[source]#

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:

GenericApiResponse

transfer_ownership_organization(

project_id: StrictInt[StrictInt],

transfer_ownership_organization_request: TransferOwnershipOrganizationRequest,

**kwargs,

) → GenericApiResponse[source]#

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:

GenericApiResponse

update_project(

project_id: StrictInt[StrictInt],

update_project_request: UpdateProjectRequest,

**kwargs,

) → GenericApiResponse[source]#

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:

GenericApiResponse

update_project_tags(

project_id: StrictInt[StrictInt],

update_project_tags_request: UpdateProjectTagsRequest,

**kwargs,

) → GenericApiResponse[source]#

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:

GenericApiResponse

update_version(

project_id: StrictInt[StrictInt],

version_id: StrictInt[StrictInt],

update_version_request: UpdateVersionRequest,

**kwargs,

) → GenericApiResponse[source]#

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:

GenericApiResponse

upload_csv_wizard_uploaded_file(

project_id: StrictInt[StrictInt],

file: StrictStr,

**kwargs,

) → GenericApiResponse[source]#

Store CSV Wizard uploaded file

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

Parameters:

project_id (int) – Project ID (required)
file (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:

GenericApiResponse

upload_readme_image(

project_id: StrictInt[StrictInt],

image: StrictStr,

**kwargs,

) → UploadReadmeImageResponse[source]#

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:

UploadReadmeImageResponse