PlatformApi
All URIs are relative to **
| Method | HTTP request | Description |
|---|---|---|
| addEvent | POST /events/{type} | Add Event |
| addModel | POST /model-repository/models | Add Model |
| addModelV2 | POST /model-repository/v2/models | Add Model V2 |
| addOptimizedModel | PUT /model-repository/models/{model_id}/optimized | Add Optimized Model |
| assertModelArguments | POST /model-repository/models/verify | Assert Model Arguments Before Upload |
| autonacModel | POST /model-repository/models/{model_id}/autonac | Autonac Model |
| buyModel | POST /events/buy-model | Buy Model |
| cancelColleagueInvite | DELETE /invites/ | Cancel Colleague Invite |
| compareModelsInModelZoo | GET /events/compare-models-in-model-zoo | Compare Models In Model Zoo |
| createWorkspace | POST /workspaces/ | Create Workspace |
| deleteConversionParameters | DELETE /conversion/{model_id} | Delete Conversion Parameters |
| deleteModel | DELETE /model-repository/models/{model_id} | Delete Model |
| deleteWorkspace | DELETE /workspaces/{id} | Delete Workspace |
| deployModelToInfery | GET /model-repository/models/{model_id}/deploy/infery | Deploy Model To Infery |
| editModel | PUT /model-repository/models/{model_id} | Edit Model |
| editUser | PUT /users/{user_id} | Edit User |
| getAllAccuracyMetrics | GET /global-configuration/accuracy-metrics | Get All Accuracy Metrics |
| getAllArchitectures | GET /global-configuration/architectures | Get All Architecture |
| getAllBatchSizes | GET /global-configuration/batch-sizes | Get All Batch Sizes |
| getAllDpTasks | GET /global-configuration/deep-learning-tasks | Get All Dp Tasks |
| getAllFeatureFlags | GET /global-configuration/feature-flags | Get All Feature Flags |
| getAllFrameworks | GET /global-configuration/frameworks | Get All Frameworks |
| getAllHardwareTypes | GET /global-configuration/hardware-types | Get All Hardware Types |
| getAllHardwares | GET /global-configuration/hardware | Get All Hardwares |
| getAllModels | GET /model-repository/models | Get Models |
| getAllPerformanceMetrics | GET /global-configuration/performance-metrics | Get All Performance Metrics |
| getAllQuantizationLevels | GET /global-configuration/quantization-levels | Get All Quantization Levels |
| getAllUsers | GET /users/ | Get All Users |
| getAllWorkspaces | GET /workspaces/ | Get Workspaces |
| getApiVersion | GET /version | Request Version |
| getArchitectures | GET /architectures | Get Architectures |
| getAutonacModelFileLink | GET /autonac/{model_name}/{file_name} | Get Model File Download Link |
| getBenchmarkRequest | GET /model-repository/models/benchmark/{benchmark_request_id} | Get Benchmark Request |
| getCompany | GET /companies/ | Get Company |
| getCompanyStats | GET /companies/stats | Get Company Stats |
| getConversionParameters | GET /conversion/{model_id} | Get Conversion Parameters |
| getEvents | GET /events/ | Get Events |
| getExperimentUploadUrl | GET /experiments/{experiment_id}/upload_url | Get Experiment Upload Url |
| getExperimentsCounter | GET /experiments/counter | Get Experiments Counter |
| getInviteByToken | GET /invites/{token} | Get Invite By Token |
| getInvites | GET /invites/ | Get Invites |
| getModelById | GET /model-repository/models/{model_id} | Get Model By Id |
| getModelByName | GET /model-repository/models/name/{name} | Get Model By Name |
| getModelSignedUrlForDownload | GET /model-repository/models/{model_id}/download-url | Get Model Signed Url For Download |
| getModelSignedUrlForUpload | GET /model-repository/models/{model_name}/upload-url | Get Model Signed Url For Upload |
| getModelZoo | GET /model-repository/model-zoo | Get Model Zoo |
| getOptimizedModels | GET /model-repository/models/{model_id}/optimized_models | Get Optimized Models |
| getSnippetsFromTemplate | GET /snippets/template/{name} | Get Snippets From Template |
| getUserActivityByUserId | GET /users/{user_id}/activity | Get User Activity By User Id |
| getUserById | GET /users/{user_id} | Get User By Id |
| getWorkspaceById | GET /workspaces/{id} | Get Workspace |
| getWorkspaceExperiments | GET /experiments/ | Get Workspace Experiments |
| getWorkspaceMembers | GET /workspaces/{workspace_id}/members | Get Workspace Members |
| getWorkspaceStats | GET /workspaces/stats | Get Workspace Stats |
| gruModel | POST /model-repository/models/{model_id}/gru | Gru Model |
| healthCheck | GET /healthz | Health |
| importPublicModel | POST /model-repository/models/public | Import Public Model |
| inviteColleagueToJoinWorkspace | POST /invites/ | Invite Colleague |
| log | POST /support/log | Upload Log |
| login | POST /auth/verification_token | Get Access Token |
| optimizeModel | POST /model-repository/models/{model_id}/optimize | Optimize Model |
| quotaIncrease | POST /events/quota-increase | Request Quota Increase |
| registerUserArchitecture | POST /architectures/user | Register User Architecture |
| requestModel | POST /events/request-model | Request Model |
| requestPublicArchitecture | GET /events/request-public-architecture | Request Public Architecture |
| requestSupport | POST /events/support | Request Support |
| resetPassword | POST /auth/reset-password | Reset Password |
| sendModelBenchmarkRequest | POST /model-repository/models/{model_id}/benchmark | Benchmark Model |
| setConversionParameters | POST /conversion/{model_id} | Set Conversion Parameters |
| setPassword | POST /auth/set-password | Set Password |
| signInWithProvider | POST /auth/sign_in/{provider} | Auth With Provider |
| signUpUser | POST /users/ | Sign Up User |
| startExperiment | POST /experiments/ | Register Experiment |
| switchToWorkspace | GET /workspaces/{workspace_id}/switch | Switch Workspace |
| updateUserActivity | PUT /users/{user_id}/activity | Update User Activity |
| updateWorkspace | PATCH /workspaces/{id} | Update Workspace |
| upgradePlan | POST /events/upgrade | Request Platform Upgrade |
| uploadLogUrl | GET /support/upload-log-url | Get Upload Support Log Url |
| validateModelName | POST /model-repository/models/verify/name | Validate Model Name |
| verifyEmail | POST /auth/email/verify/{token_key} | Verify Email Token |
addEvent
Add Event
Adds a user event for the current user.
Example
addEvent type=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| type | UserEventType | The type of the event to add. | [default to null] |
| userEventForm | UserEventForm |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
addModel
Add Model
Pushes a model into the model repository.If the model doesn't exist, we will create a new model automatically. If the model already exists, updates the model latest revision to the submitted mode
Example
addModel etag=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| etag | string | The unique ETag in S3 for the model being uploaded | [default to null] |
| modelMetadataIn | ModelMetadataIn |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
addModelV2
Add Model V2
Pushes a model into the model repository.If the model doesn't exist, we will create a new model automatically. If the model already exists, updates the model latest revision to the submitted mode
Example
addModelV2 etag=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| etag | string | The unique ETag in S3 for the model being uploaded | [default to null] |
| bodyAddModelV2 | BodyAddModelV2 |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
addOptimizedModel
Add Optimized Model
Pushes an optimized model into the model repository.The model should exist in the user's model repository before running this endpoint
Example
addOptimizedModel model_id=value etag=value optimization_state=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| modelId | string | The id of the model to update its optimized version | [default to null] |
| etag | string | The unique ETag in S3 for the optimized model | [default to null] |
| optimizationState | ModelOptimizationState | The updated optimization state to put for the model | [optional] [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
assertModelArguments
Assert Model Arguments Before Upload
Verifies the model arguments before upload to the repository.If the model doesn't exist, we will create a new model automatically
Example
assertModelArguments
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| modelMetadata | ModelMetadata |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
autonacModel
Autonac Model
AutoNAC an existing model
Example
autonacModel model_id=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| modelId | string | Base model to create an autoNAC model from | [default to null] |
Return type
APIResponseOptimizeModelResponse
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
buyModel
Buy Model
Registers when a user is interested in buying a model
Example
buyModel
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| modelPurchaseEvent | ModelPurchaseEvent |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
cancelColleagueInvite
Cancel Colleague Invite
Example
cancelColleagueInvite
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| inviteColleagueWithWorkspace | InviteColleagueWithWorkspace |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
compareModelsInModelZoo
Compare Models In Model Zoo
Registers when a user compares models in the Model Zoo page
Example
compareModelsInModelZoo Specify as: model_name=value1 model_name=value2 model_name=...
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| modelName | array[string] | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
createWorkspace
Create Workspace
Creates a workspace for the current user
Example
createWorkspace
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| workspaceForm | WorkspaceForm |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteConversionParameters
Delete Conversion Parameters
Delete additional conversion parameters for a specified model.
Example
deleteConversionParameters model_id=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| modelId | string | ID of the model to delete conversion parameters for | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteModel
Delete Model
Deletes a model from the model repository
Example
deleteModel model_id=value force_delete=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| modelId | string | The unique ID of model in the model repository. | [default to null] |
| forceDelete | boolean | [optional] [default to false] |
Return type
APIResponseDeleteModelResponse
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteWorkspace
Delete Workspace
Deletes a workspace
Example
deleteWorkspace id=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deployModelToInfery
Deploy Model To Infery
Generates code snippets to load the model on a local machine, using the Deci's Infery python package.
Example
deployModelToInfery model_id=value hardware=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| modelId | string | The unique ID of model in the model repository. | [default to null] |
| hardware | InferyVersion | The infery version that will be used. | [optional] [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
editModel
Edit Model
Edit a model of the model repository
Example
editModel model_id=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| modelId | string | The unique ID of model in the model repository. | [default to null] |
| editModelForm | EditModelForm |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
editUser
Edit User
Example
editUser user_id=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userId | string | The unique ID of user. | [default to null] |
| editUserForm | EditUserForm |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getAllAccuracyMetrics
Get All Accuracy Metrics
Get all the accuracy metrics supported by deci.
Example
getAllAccuracyMetrics
Parameters
This endpoint does not need any parameter.
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getAllArchitectures
Get All Architecture
Get all the deep learning architectures supported by deci.
Example
getAllArchitectures
Parameters
This endpoint does not need any parameter.
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getAllBatchSizes
Get All Batch Sizes
Get all the batch sizes supported by deci.
Example
getAllBatchSizes detailed=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| detailed | boolean | Whether we should return a dictionary of hardware environment to batch sizes or a list of batch sizes | [optional] [default to false] |
Return type
APIResponseUnionListDeciCommonDataTypesEnumModelsEnumsBatchSizeDictStrListPydanticTypesPositiveInt
Authorization
No authorization required
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getAllDpTasks
Get All Dp Tasks
Get all the deep learning tasks supported by deci.
Example
getAllDpTasks
Parameters
This endpoint does not need any parameter.
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getAllFeatureFlags
Get All Feature Flags
Get all the deci's feature flags.
Example
getAllFeatureFlags
Parameters
This endpoint does not need any parameter.
Return type
APIResponseListDeciInfraDataTypesFeatureFlagFeatureFlag
Authorization
No authorization required
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getAllFrameworks
Get All Frameworks
Get all the deep learning frameworks supported by deci.
Example
getAllFrameworks
Parameters
This endpoint does not need any parameter.
Return type
APIResponseListDeciCommonDataTypesEnumModelFrameworksFrameworkType
Authorization
No authorization required
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getAllHardwareTypes
Get All Hardware Types
Get all the hardware-types supported by deci.
Example
getAllHardwareTypes
Parameters
This endpoint does not need any parameter.
Return type
APIResponseListDeciCommonDataTypesHardwareHardwareReturnSchema
Authorization
No authorization required
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getAllHardwares
Get All Hardwares
Get all hardwares supported by Deci
Example
getAllHardwares
Parameters
This endpoint does not need any parameter.
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getAllModels
Get Models
Get all the models of the logged in user/organization.
Example
getAllModels reorder=value with_autonacs=value with_deleted=value Specify as: ids=value1 ids=value2 ids=...
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| reorder | boolean | [optional] [default to false] | |
| withAutonacs | boolean | [optional] [default to true] | |
| withDeleted | boolean | [optional] [default to false] | |
| ids | array[string] | List of model ids to query the models metadata from, if not given all will be fetched. | [optional] [default to null] |
Return type
APIResponseListDeciInfraDataTypesDeepLearningModelBaselineModelResponseMetadata
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getAllPerformanceMetrics
Get All Performance Metrics
Get all the performance metrics supported by deci.
Example
getAllPerformanceMetrics
Parameters
This endpoint does not need any parameter.
Return type
APIResponseListDeciCommonDataTypesEnumModelsEnumsMetric
Authorization
No authorization required
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getAllQuantizationLevels
Get All Quantization Levels
Get all the quantization levels supported by deci.
Example
getAllQuantizationLevels
Parameters
This endpoint does not need any parameter.
Return type
APIResponseListDeciCommonDataTypesEnumModelsEnumsQuantizationLevel
Authorization
No authorization required
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getAllUsers
Get All Users
Gets all the workspace users
Example
getAllUsers first_name=value last_name=value email=value self=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| firstName | string | The name of the user to filter by. | [optional] [default to null] |
| lastName | string | The name of the user to filter by. | [optional] [default to null] |
| string | The email of the user to filter by. | [optional] [default to null] | |
| self | boolean | Do you want to return only your own user metadata? | [optional] [default to false] |
Return type
APIResponseListDeciInfraDataTypesUserUser
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getAllWorkspaces
Get Workspaces
Fetches all user workspaces
Example
getAllWorkspaces
Parameters
This endpoint does not need any parameter.
Return type
APIResponseListDeciInfraDataTypesWorkspaceWorkspaceBase
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getApiVersion
Request Version
Example
getApiVersion
Parameters
This endpoint does not need any parameter.
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getArchitectures
Get Architectures
Get All Architectures
Example
getArchitectures
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getAutonacModelFileLink
Get Model File Download Link
Get a pre-signed URL to download one of an AutoNAC model's files
Example
getAutonacModelFileLink model_name=value file_name=value super_gradients_version=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| modelName | string | [default to null] | |
| fileName | AutoNACFileName | [default to null] | |
| superGradientsVersion | string | [optional] [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getBenchmarkRequest
Get Benchmark Request
Run benchmark cycle on an existing model.
Example
getBenchmarkRequest benchmark_request_id=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| benchmarkRequestId | string | The unique id of benchmark request. | [default to null] |
Return type
APIResponseBenchmarkRequestMetadata
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getCompany
Get Company
Gets the information about your company
Example
getCompany
Parameters
This endpoint does not need any parameter.
Return type
APIResponseCompanyResponseMetadata
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getCompanyStats
Get Company Stats
Gets the stats about your company
Example
getCompanyStats
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getConversionParameters
Get Conversion Parameters
Get additional conversion parameters for a specified model.
Example
getConversionParameters model_id=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| modelId | string | ID of the model to get conversion parameters for | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getEvents
Get Events
Get current user events.
Example
getEvents Specify as: type=value1 type=value2 type=... include_completed=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| type | array[UserEventType] | Get only specific types of events | [optional] [default to null] |
| includeCompleted | boolean | Whether to include already completed events of the current user | [optional] [default to false] |
Return type
APIResponseListDeciInfraDataTypesUserUserEvent
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getExperimentUploadUrl
Get Experiment Upload Url
Example
getExperimentUploadUrl experiment_id=value filename=value model_id=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| experimentId | string | [default to null] | |
| filename | string | [default to null] | |
| modelId | string | The ID of the model the experiment is running with. | [optional] [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getExperimentsCounter
Get Experiments Counter
Example
getExperimentsCounter
Parameters
This endpoint does not need any parameter.
Return type
map[String, integer]
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getInviteByToken
Get Invite By Token
Example
getInviteByToken token=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| token | string | [default to null] |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getInvites
Get Invites
Example
getInvites public=value workspace_id=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| public | boolean | [optional] [default to false] | |
| workspaceId | string | [optional] [default to null] |
Return type
APIResponseListDeciInfraDataTypesInvitationsDataTypesInviteInDB
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getModelById
Get Model By Id
Gets a model by it's unique ID
Example
getModelById model_id=value reorder=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| modelId | string | The unique ID of model in the model repository. | [default to null] |
| reorder | boolean | [optional] [default to false] |
Return type
APIResponseBaselineModelResponseMetadata
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getModelByName
Get Model By Name
Get a model with specific name
Example
getModelByName name=value reorder=value version=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| name | string | The model name | [default to null] |
| reorder | boolean | [optional] [default to false] | |
| version | string | Version of the model to retrieve (for example: 1.2) | [optional] [default to null] |
Return type
APIResponseBaselineModelResponseMetadata
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getModelSignedUrlForDownload
Get Model Signed Url For Download
Generates a temporary url, valid for 1 hour. The returned URL should be used with HTTP GET method to download the model file.
Example
getModelSignedUrlForDownload model_id=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| modelId | string | The unique ID of model in the model repository. | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getModelSignedUrlForUpload
Get Model Signed Url For Upload
Generates a temporary url that includes an access verification_token for a HTTP PUT method, So clients can upload a non-optimized version (1.0) of their model binary file. The returned URL should be used via a PUT method with the model file.
Example
getModelSignedUrlForUpload model_name=value model_version=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| modelName | string | The name of the model | [default to null] |
| modelVersion | string | The version of the model | [optional] [default to 1.0] |
Return type
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getModelZoo
Get Model Zoo
Fetches the public models for the model zoo representation
Example
getModelZoo task=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| task | DeepLearningTask | [optional] [default to null] |
Return type
APIResponseListDeciInfraDataTypesDeepLearningModelModelZooResponseMetadata
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getOptimizedModels
Get Optimized Models
Gets all optimized models of baseline model
Example
getOptimizedModels model_id=value autonac_only=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| modelId | string | The unique id of baseline model in the model repository. | [default to null] |
| autonacOnly | boolean | A predicate whether to fetch only AutoNAC optimized models. | [optional] [default to false] |
Return type
APIResponseListDeciInfraDataTypesDeepLearningModelModelMetadata
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getSnippetsFromTemplate
Get Snippets From Template
Get snippets from a template
Example
getSnippetsFromTemplate name=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| name | string | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getUserActivityByUserId
Get User Activity By User Id
Gets a activity of a user by it's unique ID
Example
getUserActivityByUserId user_id=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userId | string | The unique ID of user. | [default to null] |
Return type
APIResponseDictDeciInfraDataTypesEnumUsersEnumsActivityEventNameInt
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getUserById
Get User By Id
Gets a user by it's unique ID
Example
getUserById user_id=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userId | string | The unique ID of user. | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getWorkspaceById
Get Workspace
Fetches single workspace by its ID
Example
getWorkspaceById id=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getWorkspaceExperiments
Get Workspace Experiments
Example
getWorkspaceExperiments Specify as: architecture-ids=value1 architecture-ids=value2 architecture-ids=...
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| architectureIds | array[string] | Limit experiments to a subset of model ids | [optional] [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getWorkspaceMembers
Get Workspace Members
Returns all members of a given workspace
Example
getWorkspaceMembers workspace_id=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| workspaceId | string | [default to null] |
Return type
APIResponseListDeciInfraDataTypesUserUser
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getWorkspaceStats
Get Workspace Stats
Gets the stats about your workspace
Example
getWorkspaceStats
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
gruModel
Gru Model
Run Gru on an existing model. Gru operation runs optimization on all hardwares for batch size 1 and quantization level FP16
Example
gruModel model_id=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| modelId | string | The unique id of model in the model repository. | [default to null] |
| gruRequestForm | GruRequestForm |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
healthCheck
Health
Example
healthCheck
Parameters
This endpoint does not need any parameter.
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
importPublicModel
Import Public Model
Clone a public model into client private model repository
Example
importPublicModel public_model_id=value model_name=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| publicModelId | string | [default to null] | |
| modelName | string | Name of the requested model for get architecture recording | [optional] [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
inviteColleagueToJoinWorkspace
Invite Colleague
Example
inviteColleagueToJoinWorkspace
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| inviteColleagueWithWorkspace | InviteColleagueWithWorkspace |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
log
Upload Log
Register logs for Deci support.
Example
log
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| logRequestBody | LogRequestBody |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
login
Get Access Token
Example
login
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| username | string | [default to null] | |
| password | string | [default to null] | |
| grantType | string | [optional] [default to null] | |
| scope | string | [optional] [default to ] | |
| clientId | string | [optional] [default to null] | |
| clientSecret | string | [optional] [default to null] |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/x-www-form-urlencoded
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
optimizeModel
Optimize Model
Optimize an existing model for specific hardware.
Example
optimizeModel model_id=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| modelId | string | The unique id of model in the model repository. | [default to null] |
| optimizationRequestForm | OptimizationRequestForm |
Return type
APIResponseOptimizeModelResponse
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
quotaIncrease
Request Quota Increase
Registers when a user requests a quota increase
Example
quotaIncrease
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| quotaIncreaseRequestEvent | QuotaIncreaseRequestEvent |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
registerUserArchitecture
Register User Architecture
Register a non-AutoNAC architecture
Example
registerUserArchitecture
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| bodyRegisterUserArchitecture | BodyRegisterUserArchitecture |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
requestModel
Request Model
Registers when a user requests a missing model in the system
Example
requestModel
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| modelRequestEvent | ModelRequestEvent |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
requestPublicArchitecture
Request Public Architecture
Registers when a user request architecture in the Model Zoo page
Example
requestPublicArchitecture model_name=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| modelName | string | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
requestSupport
Request Support
Requests Deci support to contact you.
Example
requestSupport
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| supportRequestForm | SupportRequestForm |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
resetPassword
Reset Password
Example
resetPassword email=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| string | [default to null] |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
sendModelBenchmarkRequest
Benchmark Model
Run benchmark cycle on an existing model.
Example
sendModelBenchmarkRequest model_id=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| modelId | string | The unique id of model in the model repository. | [default to null] |
| bodySendModelBenchmarkRequest | BodySendModelBenchmarkRequest | [optional] |
Return type
string
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
setConversionParameters
Set Conversion Parameters
Set additional conversion parameters for a specified model.
Example
setConversionParameters model_id=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| modelId | string | ID of the model to set conversion parameters for | [default to null] |
| body | map |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
setPassword
Set Password
Example
setPassword password=value auth_token=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| password | string | [default to null] | |
| authToken | string | [default to null] |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
signInWithProvider
Auth With Provider
Server to server verification against the provider that the token is valid
Example
signInWithProvider provider=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| provider | AuthProvider | [default to null] | |
| bodySignInWithProvider | BodySignInWithProvider |
Return type
APIResponseProviderAuthenticationResponse
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
signUpUser
Sign Up User
Example
signUpUser
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| invitedSignup | InvitedSignup |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
startExperiment
Register Experiment
Register/resume a training experiment
Example
startExperiment
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| experimentForm | ExperimentForm |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
switchToWorkspace
Switch Workspace
Changes workspace context
Example
switchToWorkspace workspace_id=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| workspaceId | string | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
updateUserActivity
Update User Activity
Example
updateUserActivity user_id=value user_activity=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userId | string | The unique ID of user. | [default to null] |
| userActivity | ActivityEventName | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
updateWorkspace
Update Workspace
Updates a workspace
Example
updateWorkspace id=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | [default to null] | |
| workspaceForm | WorkspaceForm |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
upgradePlan
Request Platform Upgrade
Requests an upgrade for the platform product.
Example
upgradePlan
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
uploadLogUrl
Get Upload Support Log Url
Get URL to upload logs for Deci support.
Example
uploadLogUrl tag=value level=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tag | string | Support tag to add to logs | [optional] [default to general] |
| level | SentryLevel | Sentry log level | [optional] [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
validateModelName
Validate Model Name
Validate a model's name meets requirements: uniqueness to workspace, and format
Example
validateModelName
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| bodyValidateModelName | BodyValidateModelName |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
verifyEmail
Verify Email Token
Verifies an email after sign up, using a custom link the includes the email and the token.
Example
verifyEmail token_key=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tokenKey | string | [default to null] |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]