projects_api module

ProjectsApi

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

Parameters

  • api_client=None

Methods

add_collaborator

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

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_project_api_key

edgeimpulse_api.api.projects_api.add_project_api_key(
		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
)> 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_project_hmac_key

edgeimpulse_api.api.projects_api.add_project_hmac_key(
		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
)> 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_project

edgeimpulse_api.api.projects_api.create_project(
		self,