my-platform-sdk-package 0.1.5

A simple my_platform_sdk_package

My sdk Python client

Project description

Using my-sdk python package to querry data from my Flatform by using APIKey. For example , Getting user balance, creating a task, getting task result, getting statistics and history of models, checking API permission ...

To start, simply require the my-SDK and set up an instance with your W3AI API Keys.Please checking out your my Page. In the example below show you how to using the SDK.

Installation

pip install my-platform-sdk-package

Code sample

from my_platform_sdk_package.http_client import HttpClient, ApiError


API_KEY = "YOUR_API_KEY"

if __name__ == "__main__":
    client = HttpClient(api_key=API_KEY)

    try:        
        resp = client.api_key_service.get_balance()
        print(resp)

    except ApiError as e:
        print(e)

Documentation for API Endpoints

All URIs are relative to http://localhost/api/v1

ApiKey

Retrieve an instance of the ApiKey API:

from my_platform_sdk_package.http_client import HttpClient, ApiError


API_KEY = "YOUR_API_KEY"

if __name__ == "__main__":
    client = HttpClient(api_key=API_KEY)

    try:        
        resp = client.api_key_service
        print(resp)
        print(resp.status)
        print(resp.data.free_balance)

    except ApiError as e:
        print(e)

Endpoints

Method	HTTP request	Description
api_key_balance_get	GET /api-key/balance	Get Api Key Balance
api_key_permission_get	GET /api-key/permission	Get Api Key Permission
api_key_statistics_post	POST /api-key/statistics	Get Api Key Statistics
api_key_task_histories_get	GET /api-key/task/histories	Get Tasks Histories
api_key_task_id_cancel_delete	DELETE /api-key/task/{id}/cancel	Cancel Task By Api Key
api_key_task_id_result_get	GET /api-key/task/{id}/result	Get Task Result
api_key_task_post	POST /api-key/task	Distribute Task (Api-Key)

ApiKeyModel

Retrieve an instance of the ApiKeyModel API:

from my_platform_sdk_package.http_client import HttpClient, ApiError


API_KEY = "YOUR_API_KEY"

if __name__ == "__main__":
    client = HttpClient(api_key=API_KEY)

    try:        
        resp = client.api_key_model_service
        print(resp)

    except ApiError as e:
        print(e)

Method	HTTP request	Description
api_key_model_id_info_get	GET /api-key/model/{id}/info	Get Api Key Model Info
api_key_model_id_serving_get	GET /api-key/model/{id}/serving	Check Model Is Serving
api_key_model_id_statistics_post	POST /api-key/model/{id}/statistics	Get Model Statistics
api_key_model_id_task_cost_get	GET /api-key/model/{id}/task/cost	Get cost to compute task by model api key
api_key_model_verify_support_platforms_get	GET /api-key/model/verify/support/platforms	Get List Platforms Support By Api Key

ApiKeyModelVerify

Retrieve an instance of the ApiKeyModelVerify API:

from my_platform_sdk_package.http_client import HttpClient, ApiError


API_KEY = "YOUR_API_KEY"

if __name__ == "__main__":
    client = HttpClient(api_key=API_KEY)

    try:        
        resp = client.api_key_model_verify_service
        print(resp)

    except ApiError as e:
        print(e)

Method	HTTP request	Description
api_key_model_id_pre_verify_post	POST /api-key/model/{id}/pre-verify	Check Valid Source code To Verify Ai Model By Api Key
api_key_model_id_verify_cost_post	POST /api-key/model/{id}/verify/cost	Calculate Cost To Verify Ai Model By Api Key
api_key_model_id_verify_post	POST /api-key/model/{id}/verify	Verify Ai Model By Api Key
api_key_model_id_verify_task_get	GET /api-key/model/{id}/verify/task	Get List Verify Model Task By Commit Hash And Status
api_key_model_verify_hub_task_id_get	GET /api-key/model/verify/hub/task/{id}	Get Model Versioning By Hub Task Id By Api Key
api_key_model_verify_platform_task_id_get	GET /api-key/model/verify/platform/task/{id}	Get Verify Platform Task By Id By Api Key

ApiKeyModelVersioning

Retrieve an instance of the ApiKeyModelVersioning API:

from my_platform_sdk_package.http_client import HttpClient, ApiError


API_KEY = "YOUR_API_KEY"

if __name__ == "__main__":
    client = HttpClient(api_key=API_KEY)

    try:        
        resp = client.api_key_model_versioning_service
        print(resp)

    except ApiError as e:
        print(e)

Method	HTTP request	Description
api_key_model_id_versioning_delete	DELETE /api-key/model/{id}/versioning	Delete Model Versioning By Commit Hash By Api Key
api_key_model_id_versioning_get	GET /api-key/model/{id}/versioning	Get Current Model Versioning By Model Id By ApiKey
api_key_model_id_versioning_list_get	GET /api-key/model/{id}/versioning/list	Get Verified List Model Versioning By Api Key
api_key_model_id_versioning_put	PUT /api-key/model/{id}/versioning	Change Model Versioning By Commit Hash By Api Key

ApiKeyRepository

Retrieve an instance of the ApiKeyRepository API:

from my_platform_sdk_package.http_client import HttpClient, ApiError


API_KEY = "YOUR_API_KEY"

if __name__ == "__main__":
    client = HttpClient(api_key=API_KEY)

    try:        
        resp = client.api_key_repository_service
        print(resp)

    except ApiError as e:
        print(e)

Method	HTTP request	Description
api_key_repository_owner_username_repository_name_commit_history_get	GET /api-key/repository/{ownerUsername}/{repositoryName}/commit/history	Get commit history by repository name and branch name by api key

Documentation For Models

• ModelsApiKeyHistories
• ModelsApiKeyInfo
• ModelsApiKeyPackage
• ModelsCommit
• ModelsCommitMeta
• ModelsCommitStats
• ModelsCommitUser
• ModelsFollow
• ModelsMember
• ModelsModelVersioning
• ModelsModelVersioningGroupLite
• ModelsOffer
• ModelsPlatformTask
• ModelsQueueTask
• ModelsRepoCommit
• ModelsUser
• ModelsWallet
• ModelsWalletWithAddress
• RequestCalculateCostToVerifyAiModelRequest
• RequestCheckValidToVerifyAiModelRequest
• RequestDistributeTaskRequest
• RequestGetApiKeyStatisticsByModelIdRequest
• RequestVerifyAiModelRequest
• ResponseApiKeyHistoryListData
• ResponseApiKeyHistoryListResponse
• ResponseApiKeyInfoResponse
• ResponseCheckModelIsServingData
• ResponseCheckModelIsServingResponse
• ResponseCheckValidToVerifyAiModelData
• ResponseCheckValidToVerifyAiModelResponse
• ResponseDistributeTaskResponse
• ResponseErrorResponse
• ResponseEstimateCostData
• ResponseEstimateCostResponse
• ResponseFailResponse
• ResponseGetApiKeyPermissionData
• ResponseGetApiKeyPermissionResponse
• ResponseGetCommitHistoryData
• ResponseGetCommitHistoryResponse
• ResponseGetListModelVersioningLiteResponse
• ResponseGetListModelVersioningsLiteData
• ResponseGetListPlatformSupportResponse
• ResponseGetTaskResultData
• ResponseGetTaskResultResponse
• ResponseGetTaskStatisticsData
• ResponseGetTaskStatisticsResponse
• ResponseModelVersioningGroupLiteListData
• ResponseModelVersioningGroupLiteListResponse
• ResponseModelVersioningGroupLiteResponse
• ResponseModelVersioningResponse
• ResponseQueueTaskResponse
• ResponseResult
• ResponseSuccessResponse
• ResponseVerifyAiModelResponse
• ResponseWalletWithAddressResponse

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Author

[e-mail]