{ "openapi": "3.1.0", "info": { "title": "FastAPI", "version": "0.1.0" }, "paths": { "/api/data-hub/gpu/archive/download": { "post": { "tags": [ "/api/data-hub/gpu/archive" ], "summary": "Get a CSV download URL for GPU archive data", "operationId": "download_api_data_hub_gpu_archive_download_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/data-hub/gpu/specs-list": { "post": { "tags": [ "/api/data-hub/gpu" ], "summary": "Get all GPU product IDs from the specs list", "operationId": "specs_list_api_data_hub_gpu_specs_list_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/data-hub/gpu/specs-query": { "post": { "tags": [ "/api/data-hub/gpu" ], "summary": "Get GPU product IDs from the specs list, filtered by search conditions", "operationId": "specs_query_api_data_hub_gpu_specs_query_post", "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/app__utils__base__QueryBase" }, { "type": "null" } ], "title": "the parameter for data query", "description": "Optional parameters", "default": { "num_per_page": 50, "page_num": 1, "keyword": "" } } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/data-hub/gpu/latest/price": { "post": { "tags": [ "/api/data-hub/gpu" ], "summary": "Get GPU latest price", "operationId": "latest_price_api_data_hub_gpu_latest_price_post", "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/LatestPriceBase" }, { "type": "null" } ], "title": "the parameter for data query", "description": "Optional parameters", "default": { "num_per_page": 50, "page_num": 1, "keyword": "", "product_id": 0, "country": "" } } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/data-hub/gpu/history/price": { "post": { "tags": [ "/api/data-hub/gpu" ], "summary": "Get GPU history price", "operationId": "rental_price_api_data_hub_gpu_history_price_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryPriceBase" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/data-hub/gpu/country/summary": { "post": { "tags": [ "/api/data-hub/gpu/country" ], "summary": "Get GPU Country Level summary information", "operationId": "summary_api_data_hub_gpu_country_summary_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/data-hub/gpu/country/filter-map": { "post": { "tags": [ "/api/data-hub/gpu/country" ], "summary": "Get all filter dictionary map data", "operationId": "filter_map_api_data_hub_gpu_country_filter_map_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/data-hub/gpu/country/latest-price": { "post": { "tags": [ "/api/data-hub/gpu/country" ], "summary": "Get GPU Country Level latest price", "operationId": "latest_price_api_data_hub_gpu_country_latest_price_post", "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/LatestPriceBase" }, { "type": "null" } ], "title": "the parameter for data query", "description": "Optional parameters", "default": { "num_per_page": 50, "page_num": 1, "keyword": "", "product_id": 0, "country": "" } } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/data-hub/gpu/country/filter-price": { "post": { "tags": [ "/api/data-hub/gpu/country" ], "summary": "Get GPU country-level prices filtered by condition", "operationId": "filter_price_api_data_hub_gpu_country_filter_price_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/app__api__gpu__country_price__FilterPriceBase" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/data-hub/gpu/partner/provider-list": { "post": { "tags": [ "/api/data-hub/gpu/partner" ], "summary": "Get all provider source list", "operationId": "provider_list_api_data_hub_gpu_partner_provider_list_post", "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/app__utils__base__QueryBase" }, { "type": "null" } ], "title": "the parameter for data query", "description": "Optional parameters", "default": { "num_per_page": 50, "page_num": 1, "keyword": "" } } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/data-hub/gpu/partner/specs-list": { "post": { "tags": [ "/api/data-hub/gpu/partner" ], "summary": "Get all GPU product specs from the specs list", "operationId": "slug_list_api_data_hub_gpu_partner_specs_list_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/data-hub/gpu/partner/specs-query": { "post": { "tags": [ "/api/data-hub/gpu/partner" ], "summary": "Get GPU product specs from the specs list, filtered by search conditions", "operationId": "specs_query_api_data_hub_gpu_partner_specs_query_post", "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/app__utils__base__QueryBase" }, { "type": "null" } ], "title": "the parameter for data query", "description": "Optional parameters", "default": { "num_per_page": 50, "page_num": 1, "keyword": "" } } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/data-hub/gpu/partner/latest-price": { "post": { "tags": [ "/api/data-hub/gpu/partner" ], "summary": "Get GPU latest price by provider", "operationId": "latest_price_api_data_hub_gpu_partner_latest_price_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerLatestPriceBase" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/data-hub/gpu/instance/summary": { "post": { "tags": [ "/api/data-hub/gpu/instance" ], "summary": "Get GPU Instance Level summary information", "operationId": "summary_api_data_hub_gpu_instance_summary_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/data-hub/gpu/instance/filter-map": { "post": { "tags": [ "/api/data-hub/gpu/instance" ], "summary": "Get all filter dictionary map data", "operationId": "filter_map_api_data_hub_gpu_instance_filter_map_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/data-hub/gpu/instance/latest-price": { "post": { "tags": [ "/api/data-hub/gpu/instance" ], "summary": "Get GPU Instance latest price by provider", "operationId": "latest_price_api_data_hub_gpu_instance_latest_price_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstancePriceBase" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/data-hub/gpu/instance/filter-price": { "post": { "tags": [ "/api/data-hub/gpu/instance" ], "summary": "Get GPU instance-level prices filtered by condition", "operationId": "filter_price_api_data_hub_gpu_instance_filter_price_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/app__api__gpu__instance_price__FilterPriceBase" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/data-hub/gpu/common/specs-list": { "post": { "tags": [ "/api/data-hub/gpu/common" ], "summary": "Get all GPU product IDs from the specs list", "operationId": "specs_list_api_data_hub_gpu_common_specs_list_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/data-hub/gpu/common/gpu-spot-price": { "post": { "tags": [ "/api/data-hub/gpu/common" ], "summary": "Get the GPU spot price data.", "operationId": "gpu_spot_price_api_data_hub_gpu_common_gpu_spot_price_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/app__api__gpu__common__SpotPriceBase" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/data-hub/gpu/common/gpu-price-trend": { "post": { "tags": [ "/api/data-hub/gpu/common" ], "summary": "Get the GPU price trend data.", "operationId": "gpu_price_trend_api_data_hub_gpu_common_gpu_price_trend_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriceTrendBase" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/data-hub/gpu/common/country-list": { "post": { "tags": [ "/api/data-hub/gpu/common" ], "summary": "Get all country list by the special GPU product slug", "operationId": "country_list_api_data_hub_gpu_common_country_list_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductSlugBase" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/data-hub/gpu/market/specs-list": { "post": { "tags": [ "/api/data-hub/gpu/market" ], "summary": "Get all GPU product IDs from the specs list", "operationId": "specs_list_api_data_hub_gpu_market_specs_list_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/data-hub/gpu/market/gpu-spot-price": { "post": { "tags": [ "/api/data-hub/gpu/market" ], "summary": "Get the GPU spot price data.", "operationId": "gpu_spot_price_api_data_hub_gpu_market_gpu_spot_price_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/app__api__gpu__market_trend__SpotPriceBase" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/data-hub/gpu/market/gpu-price-trend": { "post": { "tags": [ "/api/data-hub/gpu/market" ], "summary": "Get the GPU price trend data.", "operationId": "gpu_price_trend_api_data_hub_gpu_market_gpu_price_trend_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriceTrendBase" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/user/login": { "post": { "tags": [ "/api/user" ], "summary": "User login with the mail and password parameters then get the access_token and id_token", "operationId": "login_api_user_login_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginBody", "title": "user login", "description": "login the user and get access_token" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/user/me": { "get": { "tags": [ "/api/user" ], "summary": "Get the user's information with id_token", "operationId": "me_api_user_me_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/user/forgot-password": { "post": { "tags": [ "/api/user" ], "summary": "Send a confirmation code to the user to reset the password.", "operationId": "forgot_password_api_user_forgot_password_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/app__api__silicon__user__EmailBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/user/reset-password": { "post": { "tags": [ "/api/user" ], "summary": "Reset the password for the user with the confirmation code", "operationId": "reset_password_api_user_reset_password_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResetPasswordBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/user/delete-current-account": { "delete": { "tags": [ "/api/user" ], "summary": "Delete the account of the currently logged-in user.", "description": "Deletes the currently authenticated user's account. Requires that the user is already logged in and authenticated, with a valid access_token.", "operationId": "delete_current_user_api_user_delete_current_account_delete", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/user/logout": { "post": { "tags": [ "/api/user" ], "summary": "Logout the user and revoke all the tokens for the user", "operationId": "logout_api_user_logout_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/application/generate-token": { "post": { "tags": [ "/api/application" ], "summary": "Using the application client_id and client_secret to generate a temporary token.", "operationId": "generate_token_api_application_generate_token_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateTokenBody", "title": "application information", "description": "login the user and get token" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/application/token-info": { "get": { "tags": [ "/api/application" ], "summary": "Get your app-token information by the temporary token.", "operationId": "token_info_api_application_token_info_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/data-hub/carbon/gpu-carbon-intensity": { "get": { "tags": [ "/api/data-hub/carbon" ], "summary": "Batch query carbon intensity of GPUs", "operationId": "gpu_carbon_intensity_api_data_hub_carbon_gpu_carbon_intensity_get", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "gpu_slug", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "GPU slug", "title": "Gpu Slug" }, "description": "GPU slug" }, { "name": "gpu_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "GPU full name. if GPU slug is filled in, full name will be overridden; if GPU slug is not provided, full name shall be required.", "title": "Gpu Name" }, "description": "GPU full name. if GPU slug is filled in, full name will be overridden; if GPU slug is not provided, full name shall be required." }, { "name": "hours_used", "in": "query", "required": true, "schema": { "type": "number", "exclusiveMinimum": 0, "description": "GPU used in hours, should be greater then 0", "title": "Hours Used" }, "description": "GPU used in hours, should be greater then 0" }, { "name": "zipcode", "in": "query", "required": true, "schema": { "type": "string", "description": "Zip code of data center", "title": "Zipcode" }, "description": "Zip code of data center" }, { "name": "country_code", "in": "query", "required": true, "schema": { "type": "string", "description": "County code of data center, represented in ISO 3166-1 alpha 2, e.g., 'US' representing United States", "title": "Country Code" }, "description": "County code of data center, represented in ISO 3166-1 alpha 2, e.g., 'US' representing United States" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "/api/data-hub/carbon" ], "summary": "Calculate carbon intensity of GPU", "operationId": "calculate_GPU_carbon_intensity_post_method_api_data_hub_carbon_gpu_carbon_intensity_post", "security": [ { "OAuth2PasswordBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GPUCarbonIntensityRequestBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/data-hub/carbon/zone-emission-rate": { "get": { "tags": [ "/api/data-hub/carbon" ], "summary": "Query carbon emission rate by zipcode and country code", "operationId": "zone_emission_rate_api_data_hub_carbon_zone_emission_rate_get", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "zipcode", "in": "query", "required": true, "schema": { "type": "string", "description": "Zip code", "title": "Zipcode" }, "description": "Zip code" }, { "name": "country_code", "in": "query", "required": true, "schema": { "type": "string", "description": "Country code, represented in ISO 3166-1 alpha-2 format, e.g., 'US' for United States", "title": "Country Code" }, "description": "Country code, represented in ISO 3166-1 alpha-2 format, e.g., 'US' for United States" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/data-hub/carbon/gpu-carbon-provider-intensity": { "get": { "tags": [ "/api/data-hub/carbon" ], "summary": "Calculate carbon provider intensity of GPU", "operationId": "calculate_GPU_carbon_provider_intensity_api_data_hub_carbon_gpu_carbon_provider_intensity_get", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "gpu_slug", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "GPU slug", "title": "Gpu Slug" }, "description": "GPU slug" }, { "name": "gpu_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "GPU full name. if GPU slug is filled in, full name will be overridden; if GPU slug is not provided, full name shall be required.", "title": "Gpu Name" }, "description": "GPU full name. if GPU slug is filled in, full name will be overridden; if GPU slug is not provided, full name shall be required." }, { "name": "hours_used", "in": "query", "required": true, "schema": { "type": "number", "exclusiveMinimum": 0, "description": "GPU used in hours, should be greater then 0", "title": "Hours Used" }, "description": "GPU used in hours, should be greater then 0" }, { "name": "provider", "in": "query", "required": true, "schema": { "type": "string", "description": "Name of the provider", "title": "Provider" }, "description": "Name of the provider" }, { "name": "provider_code", "in": "query", "required": true, "schema": { "type": "string", "description": "Unique code of the provider", "title": "Provider Code" }, "description": "Unique code of the provider" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/data-hub/carbon/batch/gpu-carbon-intensity": { "post": { "tags": [ "/api/data-hub/carbon" ], "summary": "Batch query carbon intensity of GPUs", "operationId": "batch_query_GPU_carbon_intensity_api_data_hub_carbon_batch_gpu_carbon_intensity_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchQueryGPUCarbonIntensityRequest", "title": "List of GPU querying arguments", "description": "List of GPU querying arguments." } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/data-hub/carbon/country": { "get": { "tags": [ "/api/data-hub/carbon" ], "summary": "Query Country's detail information", "operationId": "country_api_data_hub_carbon_country_get", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "country_name", "in": "query", "required": false, "schema": { "type": "string", "description": "Country name, support fuzzy search. If no name filled in, then return all countries.", "title": "Country Name" }, "description": "Country name, support fuzzy search. If no name filled in, then return all countries." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/data-hub/carbon/default-zipcode": { "get": { "tags": [ "/api/data-hub/carbon" ], "summary": "Query the default zipcode of the country by country code", "operationId": "get_default_zipcode_by_country_api_data_hub_carbon_default_zipcode_get", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "country_code", "in": "query", "required": true, "schema": { "type": "string", "description": "Country code, represented in ISO 3166-1 alpha-2 format, e.g., 'US' for United States", "title": "Country Code" }, "description": "Country code, represented in ISO 3166-1 alpha-2 format, e.g., 'US' for United States" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/data-hub/carbon/providers/": { "get": { "tags": [ "/api/data-hub/carbon" ], "summary": "Get all providers", "operationId": "get_all_providers_api_data_hub_carbon_providers__get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/data-hub/carbon/providers/{provider_name}/codes": { "get": { "tags": [ "/api/data-hub/carbon" ], "summary": "Get the provider code by provider name", "operationId": "get_provider_codes_api_data_hub_carbon_providers__provider_name__codes_get", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Provider Name" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/data-hub/carbonproviders_selection/{provider_name}/codes": { "get": { "tags": [ "/api/data-hub/carbon" ], "summary": "Get the provider code by provider name", "operationId": "get_codes_by_provider_route_api_data_hub_carbonproviders_selection__provider_name__codes_get", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "provider_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Provider Name" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/data-hub/carbon/providers_with_codes/": { "get": { "tags": [ "/api/data-hub/carbon" ], "summary": "Get all providers with codes", "operationId": "get_all_providers_with_codes_api_data_hub_carbon_providers_with_codes__get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/token-price/book/latest": { "post": { "tags": [ "/api/token-price" ], "summary": "Get the latest token price book data as a sample data", "operationId": "book_latest_api_token_price_book_latest_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/token-price/book/preview": { "post": { "tags": [ "/api/token-price" ], "summary": "Get all token price book data as a dataview", "operationId": "book_preview_api_token_price_book_preview_post", "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SearchBody" }, { "type": "null" } ], "title": "the parameter for data query", "description": "Optional parameters", "default": { "filter": [], "order_by": [], "paginate": { "num_per_page": 50, "page_num": 1 } } } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/token-price/pulse/latest": { "post": { "tags": [ "/api/token-price" ], "summary": "Get all token market pulse data as a sample data", "operationId": "pulse_latest_api_token_price_pulse_latest_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/token-price/pulse/preview": { "post": { "tags": [ "/api/token-price" ], "summary": "Get the latest token market pulse data as a dataview", "operationId": "pulse_preview_api_token_price_pulse_preview_post", "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SearchBody" }, { "type": "null" } ], "title": "the parameter for data query", "description": "Optional parameters", "default": { "filter": [], "order_by": [], "paginate": { "num_per_page": 50, "page_num": 1 } } } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/token-price/pulse/trend": { "post": { "tags": [ "/api/token-price" ], "summary": "Get the latest 30 days trend data for token market pulse", "operationId": "pulse_trend_api_token_price_pulse_trend_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostBlendedBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/token-price/download": { "post": { "tags": [ "/api/token-price" ], "summary": "Get a CSV download URL for token price data", "operationId": "download_api_token_price_download_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/gpu-forward/latest": { "post": { "tags": [ "/api/gpu-forward" ], "summary": "Get all GPU latest rental forward rate price data in the dashboard", "operationId": "latest_api_gpu_forward_latest_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/gpu-forward/forward": { "post": { "tags": [ "/api/gpu-forward" ], "summary": "Get all GPU rental forward data in the dashboard", "operationId": "forward_api_gpu_forward_forward_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForwardRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/gpu-forward/history": { "post": { "tags": [ "/api/gpu-forward" ], "summary": "Get the real historical GPU forward near-term rate for a date range in a single request", "description": "Unlike /forward, which returns a single as-of curve (all terms) for one day, this endpoint returns real historical data for a date range: for each day between starting_date and ending_date, it returns the actual term value from that day's as-of curve, rather than mapping today's curve onto past date labels. Mapping today's curve onto past dates would make historical charts disagree with /forward or downloaded data for the same date, since the chart would show \"a term from today's curve\" rather than \"the real curve for that day.\"\n\nThe date range can be specified in one of two mutually exclusive ways:\n- starting_date and ending_date: an explicit range, consistent with the GPU Index history endpoints.\n- latest_days: matches common time-range selections (for example 30 days, 1 year, all time, or year-to-date). Use 0 for unspecified, a positive number N for the last N days, -1 for all available data, or -2 for year-to-date. These relative ranges are calculated from the latest date with available data for this GPU, not from today's date.", "operationId": "history_api_gpu_forward_history_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForwardHistoryRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/gpu-forward/download": { "post": { "tags": [ "/api/gpu-forward" ], "summary": "Get a CSV download URL for GPU forward rate data", "operationId": "download_api_gpu_forward_download_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/price-iq/v2/quarterly-trends": { "post": { "tags": [ "/api/price-iq/v2" ], "summary": "Get quarterly PriceIQ trends", "operationId": "quarterly_trends_api_price_iq_v2_quarterly_trends_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuarterlyTrendsRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/price-iq/v2/regional-trends": { "post": { "tags": [ "/api/price-iq/v2" ], "summary": "Get regional PriceIQ trends", "operationId": "regional_trends_api_price_iq_v2_regional_trends_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegionalTrendsRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/price-iq/v2/geography-distribution": { "post": { "tags": [ "/api/price-iq/v2" ], "summary": "Get PriceIQ geography distribution", "operationId": "geography_distribution_api_price_iq_v2_geography_distribution_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeographyDistributionRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/ram-index/index": { "post": { "tags": [ "/api/ram-index" ], "summary": "Get RAM index data from a starting date (earliest: 2026-01-26) to an ending date. If no date range is specified, the default is today. If the value returned is -1 or negative, no data has been generated yet — please wait or contact us.", "operationId": "index_api_ram_index_index_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RamRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/ram-index/limited/index": { "post": { "tags": [ "/api/ram-index" ], "summary": "Get RAM index data from a starting date (earliest: 2026-01-26) to an ending date. The date range must not exceed one week (7 days).", "operationId": "limited_index_api_ram_index_limited_index_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RamRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/ram-index/download": { "post": { "tags": [ "/api/ram-index" ], "summary": "Get a CSV download URL for RAM index data", "operationId": "download_api_ram_index_download_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/gpu-index/index": { "post": { "tags": [ "/api/gpu-index" ], "summary": "Get GPU index data from a starting date (earliest: 2024-09-01) to an ending date. If no date range is specified, the default is today. If the value returned is -1 or negative, no data has been generated yet — please wait or contact us.", "operationId": "index_api_gpu_index_index_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/gpu-index/limited/index": { "post": { "tags": [ "/api/gpu-index" ], "summary": "Get the latest 7 days of free GPU index data", "operationId": "limited_index_api_gpu_index_limited_index_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/gpu-index/source-price": { "post": { "tags": [ "/api/gpu-index" ], "summary": "Get the underlying source price data used to calculate the GPU index, for the latest 7 days", "operationId": "source_price_api_gpu_index_source_price_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourcePriceRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/gpu-index/dashboard": { "post": { "tags": [ "/api/gpu-index" ], "summary": "Get the latest 3 months of GPU dashboard data", "operationId": "dashboard_api_gpu_index_dashboard_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/app__api__price__gpu_index__DashboardRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/gpu-index/download": { "post": { "tags": [ "/api/gpu-index" ], "summary": "Get a CSV download URL for GPU index data", "operationId": "download_api_gpu_index_download_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/forward-residual/latest": { "post": { "tags": [ "/api/forward-residual" ], "summary": "Get latest valid forward residual data", "operationId": "latest_api_forward_residual_latest_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/forward-residual/dashboard": { "post": { "tags": [ "/api/forward-residual" ], "summary": "Get valid forward residual dashboard data", "operationId": "dashboard_api_forward_residual_dashboard_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/app__api__price__forward_residual__DashboardRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/forward-residual/value": { "post": { "tags": [ "/api/forward-residual" ], "summary": "Get historical residual values for all GPUs with product access", "description": "Omit dates to query the complete supported history. Omit gpu_list to include A100, H100, and B200.", "operationId": "value_api_forward_residual_value_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/app__api__price__forward_residual__DashboardRequest", "default": {} } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/forward-residual/specs-list": { "get": { "tags": [ "/api/forward-residual" ], "summary": "Get supported GPUs and Forward Residual date ranges", "description": "Returns each GPU's queryable date range and the overall earliest and latest available dates. Requires an active product purchase that grants this endpoint, except for system administrators.", "operationId": "specs_list_api_forward_residual_specs_list_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/forward-residual/limited/dashboard": { "post": { "tags": [ "/api/forward-residual" ], "summary": "Get the latest 3 calendar months of Forward Residual dashboard data", "operationId": "limited_dashboard_api_forward_residual_limited_dashboard_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/app__api__price__forward_residual__DashboardRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/forward-residual/download": { "post": { "tags": [ "/api/forward-residual" ], "summary": "Get a CSV download URL for forward residual data", "operationId": "download_api_forward_residual_download_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/price-iq/predict": { "post": { "tags": [ "/api/price-iq" ], "summary": "get predict price and percentile data", "operationId": "predict_api_price_iq_predict_post", "security": [ { "OAuth2PasswordBearer": [] } ], "parameters": [ { "name": "product_name", "in": "query", "required": false, "schema": { "default": "price-iq", "title": "Product Name" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PredictBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/price-iq/specs-list": { "get": { "tags": [ "/api/price-iq" ], "summary": "Get all support GPU type, geolocation, cpu_platform and price_type list", "operationId": "spec_list_api_price_iq_specs_list_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/ai-insights/latest": { "post": { "tags": [ "/api/ai-insights" ], "summary": "Get latest AI insight bullet points by index type and object, generating them if missing", "operationId": "latest_api_ai_insights_latest_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LatestInsightsRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/token-index/index": { "post": { "tags": [ "/api/token-index" ], "summary": "Get token index data from a starting date to an ending date. If no date range is specified, the default is today. If the value returned is -1 or negative, no data has been generated yet.", "operationId": "index_api_token_index_index_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenIndexRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/token-index/limited/index": { "post": { "tags": [ "/api/token-index" ], "summary": "Get token index data within the latest 7-day or 30-day window", "operationId": "limited_index_api_token_index_limited_index_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenIndexRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/token-index/latest-date": { "get": { "tags": [ "/api/token-index" ], "summary": "Get latest valid token index date", "operationId": "latest_date_api_token_index_latest_date_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/token-index/specs-list": { "get": { "tags": [ "/api/token-index" ], "summary": "Get all parameter list for token index API", "operationId": "spec_list_api_token_index_specs_list_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/token-index/dashboard": { "post": { "tags": [ "/api/token-index" ], "summary": "Get all token index data in the dashboard", "operationId": "dashboard_api_token_index_dashboard_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/app__api__price__token_index__DashboardRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/token-index/download": { "post": { "tags": [ "/api/token-index" ], "summary": "Get a CSV download URL for token index data", "operationId": "download_api_token_index_download_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/site-iq/regions": { "post": { "tags": [ "/api/site-iq" ], "summary": "List all SiteIQ regions", "operationId": "list_regions_api_site_iq_regions_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/RegionOut" }, "type": "array", "title": "Response List Regions Api Site Iq Regions Post" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/site-iq/regions/info": { "post": { "tags": [ "/api/site-iq" ], "summary": "Get one SiteIQ region", "operationId": "get_region_api_site_iq_regions_info_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegionInfoRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegionOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/site-iq/gpu-specs": { "post": { "tags": [ "/api/site-iq" ], "summary": "List SiteIQ GPU deployment profiles", "operationId": "list_gpu_profiles_api_site_iq_gpu_specs_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/GpuProfileOut" }, "type": "array", "title": "Response List Gpu Profiles Api Site Iq Gpu Specs Post" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/site-iq/gpu-specs/info": { "post": { "tags": [ "/api/site-iq" ], "summary": "Get one SiteIQ GPU deployment profile", "operationId": "get_gpu_profile_api_site_iq_gpu_specs_info_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GpuProfileInfoRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GpuProfileOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/site-iq/rental-prices": { "post": { "tags": [ "/api/site-iq" ], "summary": "List aggregated latest rental prices", "operationId": "get_rental_prices_api_site_iq_rental_prices_post", "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/RentalPricesRequest" }, { "type": "null" } ], "title": "Request Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/RentalPriceOut" }, "type": "array", "title": "Response Get Rental Prices Api Site Iq Rental Prices Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/site-iq/rental-price": { "post": { "tags": [ "/api/site-iq" ], "summary": "Lookup latest average rental price", "operationId": "get_avg_rental_price_api_site_iq_rental_price_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RentalPriceLookupRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RentalPriceLookupOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/site-iq/rental-price/latest-date": { "post": { "tags": [ "/api/site-iq" ], "summary": "Get the latest rental market date", "operationId": "get_rental_latest_date_api_site_iq_rental_price_latest_date_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/site-iq/limited/bootstrap": { "post": { "tags": [ "/api/site-iq" ], "summary": "Get limited SiteIQ bootstrap options", "operationId": "limited_bootstrap_api_site_iq_limited_bootstrap_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/site-iq/calculate": { "post": { "tags": [ "/api/site-iq" ], "summary": "Run the SiteIQ capacity and profitability model", "operationId": "run_calculation_api_site_iq_calculate_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalculateRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalculateResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/site-iq/limited/calculate": { "post": { "tags": [ "/api/site-iq" ], "summary": "Run one limited SiteIQ calculation per day", "operationId": "run_limited_calculation_api_site_iq_limited_calculate_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalculateRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalculateResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/site-iq/historical-records": { "post": { "tags": [ "/api/site-iq" ], "summary": "List recent SiteIQ historical records for the current user", "operationId": "list_historical_records_api_site_iq_historical_records_post", "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HistoricalRecordsRequest" }, { "type": "null" } ], "title": "Request Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/HistoricalRecordOut" }, "type": "array", "title": "Response List Historical Records Api Site Iq Historical Records Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/site-iq/templates/create": { "post": { "tags": [ "/api/site-iq" ], "summary": "Save current SiteIQ parameters as a template", "operationId": "create_template_api_site_iq_templates_create_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateCreateRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/site-iq/templates": { "post": { "tags": [ "/api/site-iq" ], "summary": "List SiteIQ templates for the current user", "operationId": "list_templates_api_site_iq_templates_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/TemplateOut" }, "type": "array", "title": "Response List Templates Api Site Iq Templates Post" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/site-iq/templates/info": { "post": { "tags": [ "/api/site-iq" ], "summary": "Get one SiteIQ template for the current user", "operationId": "get_template_api_site_iq_templates_info_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateInfoRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/site-iq/templates/delete": { "post": { "tags": [ "/api/site-iq" ], "summary": "Delete one SiteIQ template for the current user", "operationId": "delete_template_api_site_iq_templates_delete_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateInfoRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateDeleteResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/site-iq/calculations/info": { "post": { "tags": [ "/api/site-iq" ], "summary": "Get one stored SiteIQ calculation", "operationId": "get_calculation_api_site_iq_calculations_info_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalculationInfoRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalculationRecordOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/payment/subscription/create": { "post": { "tags": [ "/api/payment" ], "summary": "Create a subscription for a customer at Stripe side.", "description": "Create a subscription for a customer at Stripe side.", "operationId": "create_subscription_api_payment_subscription_create_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionRequestBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/payment/subscription/upgrade-confirm": { "post": { "tags": [ "/api/payment" ], "summary": "Generate a Stripe-hosted confirmation link to upgrade Pro_legacy/Pro_499 to Pro.", "description": "Generates a Stripe-hosted confirmation link for upgrading from Pro_legacy or Pro_499 to Pro. Unlike a direct upgrade, this endpoint does not charge the customer immediately — it returns a confirmation link (session.url) that can be shown in the application or sent by email. The customer reviews the proration details on Stripe's hosted page and must confirm before the plan change and charge take effect. No changes are made until the customer confirms.", "operationId": "upgrade_subscription_link_api_payment_subscription_upgrade_confirm_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerPortalSessionRequestBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/payment/prices/list": { "get": { "tags": [ "/api/payment" ], "summary": "Get the list of prices at Stripe side.", "description": "Get the list of prices at Stripe side.", "operationId": "get_prices_list_api_payment_prices_list_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/payment/customer_portal_session/create": { "post": { "tags": [ "/api/payment" ], "summary": "Create a customer portal session at Stripe side.", "description": "Create a customer portal session at Stripe side.", "operationId": "create_customer_portal_session_api_payment_customer_portal_session_create_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerPortalSessionRequestBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/silicon-navigator/gpu-list": { "get": { "tags": [ "/api/silicon-navigator" ], "summary": "Get GPU List information", "operationId": "gpu_list_api_silicon_navigator_gpu_list_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/silicon-navigator/gpu-specs/params": { "get": { "tags": [ "/api/silicon-navigator" ], "summary": "Get GPU specs params", "operationId": "gpu_specs_params_api_silicon_navigator_gpu_specs_params_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/silicon-navigator/gpu-specs": { "post": { "tags": [ "/api/silicon-navigator" ], "summary": "Get GPU specs list", "operationId": "gpu_specs_api_silicon_navigator_gpu_specs_post", "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SearchBody" }, { "type": "null" } ], "title": "the parameter for data query", "description": "Optional parameters", "default": { "filter": [], "order_by": [], "paginate": { "num_per_page": 50, "page_num": 1 } } } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/api/silicon-mark/test-job/token-info": { "get": { "tags": [ "/api/silicon-mark/test-job" ], "summary": "Get your job-token information which created by the test-job.", "operationId": "token_info_api_silicon_mark_test_job_token_info_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "OAuth2PasswordBearer": [] } ] } }, "/": { "get": { "summary": "Root", "operationId": "root__get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } } }, "components": { "schemas": { "AlertOut": { "properties": { "level": { "type": "string", "enum": [ "error", "warning", "info" ], "title": "Level" }, "code": { "type": "string", "title": "Code" }, "message": { "type": "string", "title": "Message" } }, "type": "object", "required": [ "level", "code", "message" ], "title": "AlertOut" }, "BatchQueryGPUCarbonIntensityRequest": { "properties": { "data": { "items": { "$ref": "#/components/schemas/BatchQueryGPUCarbonIntensityRequestData" }, "type": "array", "title": "Data", "description": "List of the GPU carbon intensity querying arguments", "default": [] } }, "type": "object", "title": "BatchQueryGPUCarbonIntensityRequest" }, "BatchQueryGPUCarbonIntensityRequestData": { "properties": { "gpu_slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gpu Slug", "description": "GPU Slug, if gpu_name is None, this field should be fulled in." }, "gpu_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gpu Name", "description": "GPU Name, if gpu_slug is filled in, this field will be overridden; If gpu_slug is None, this field is required." }, "hours_used": { "type": "number", "exclusiveMinimum": 0, "title": "Hours Used", "description": "GPU used in hours, should be greater then 0" }, "zipcode": { "type": "string", "title": "Zipcode", "description": "Zipcode of data center." }, "country_code": { "type": "string", "title": "Country Code", "description": "Country code of data center, represented in ISO 3166-1 alpha 2, e.g., 'US' standing for United States." } }, "type": "object", "required": [ "hours_used", "zipcode", "country_code" ], "title": "BatchQueryGPUCarbonIntensityRequestData" }, "BreakEvenPointOut": { "properties": { "utilization_pct": { "type": "integer", "title": "Utilization Pct" }, "monthly_revenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Monthly Revenue" }, "monthly_profit": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Monthly Profit" }, "margin": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Margin" } }, "type": "object", "required": [ "utilization_pct" ], "title": "BreakEvenPointOut" }, "BreakEvenResultOut": { "properties": { "break_even_utilization_pct": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Break Even Utilization Pct" }, "curve": { "items": { "$ref": "#/components/schemas/BreakEvenPointOut" }, "type": "array", "title": "Curve" } }, "type": "object", "required": [ "curve" ], "title": "BreakEvenResultOut" }, "CalculateRequest": { "properties": { "total_mw": { "type": "number", "title": "Total Mw" }, "usable_sqft": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Usable Sqft" }, "region_id": { "type": "integer", "exclusiveMinimum": 0, "title": "Region Id" }, "cooling_type": { "type": "string", "enum": [ "air", "liquid", "immersion" ], "title": "Cooling Type" }, "gpu_model": { "type": "string", "maxLength": 50, "minLength": 1, "title": "Gpu Model" }, "rental_product_slug": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ], "title": "Rental Product Slug" }, "rental_source": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ], "title": "Rental Source" }, "rental_type": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Rental Type" }, "rental_provider_source_type": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ], "title": "Rental Provider Source Type" }, "workload_type": { "type": "string", "enum": [ "training", "inference", "both" ], "title": "Workload Type", "default": "training" }, "redundancy_mode": { "type": "string", "enum": [ "none", "tier3_n_plus_1", "tier3_2n", "three_n_over_two" ], "title": "Redundancy Mode", "default": "none" }, "utilization_rate": { "type": "number", "title": "Utilization Rate", "default": 0.95 }, "custom_effective_pue": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Custom Effective Pue" }, "custom_rental_price_per_gpu_hr": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Custom Rental Price Per Gpu Hr" }, "custom_electricity_price_kwh": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Custom Electricity Price Kwh" }, "capacity_overrides": { "anyOf": [ { "$ref": "#/components/schemas/CapacityOverridesIn" }, { "type": "null" } ] } }, "type": "object", "required": [ "total_mw", "region_id", "cooling_type", "gpu_model" ], "title": "CalculateRequest" }, "CalculateResponse": { "properties": { "inputs": { "$ref": "#/components/schemas/InputsSummaryOut" }, "capacity": { "$ref": "#/components/schemas/CapacityResultOut" }, "financials": { "$ref": "#/components/schemas/FinancialResultOut" }, "insights": { "$ref": "#/components/schemas/DashboardInsightsOut" }, "alerts": { "items": { "$ref": "#/components/schemas/AlertOut" }, "type": "array", "title": "Alerts" }, "calculation_id": { "type": "integer", "title": "Calculation Id" } }, "type": "object", "required": [ "inputs", "capacity", "financials", "insights", "alerts", "calculation_id" ], "title": "CalculateResponse" }, "CalculationInfoRequest": { "properties": { "calculation_id": { "type": "integer", "exclusiveMinimum": 0, "title": "Calculation Id" } }, "type": "object", "required": [ "calculation_id" ], "title": "CalculationInfoRequest" }, "CalculationRecordOut": { "properties": { "id": { "type": "integer", "title": "Id" }, "region_id": { "type": "integer", "title": "Region Id" }, "gpu_profile_id": { "type": "integer", "title": "Gpu Profile Id" }, "gpu_model": { "type": "string", "title": "Gpu Model" }, "total_mw": { "type": "number", "title": "Total Mw" }, "usable_sqft": { "type": "number", "title": "Usable Sqft" }, "cooling_type": { "type": "string", "enum": [ "air", "liquid", "immersion" ], "title": "Cooling Type" }, "workload_type": { "type": "string", "enum": [ "training", "inference", "both" ], "title": "Workload Type" }, "redundancy_mode": { "type": "string", "enum": [ "none", "tier3_n_plus_1", "tier3_2n", "three_n_over_two" ], "title": "Redundancy Mode" }, "utilization_rate": { "type": "number", "title": "Utilization Rate" }, "rental_product_slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rental Product Slug" }, "rental_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rental Source" }, "rental_type": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Rental Type" }, "rental_provider_source_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rental Provider Source Type" }, "custom_rental_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Custom Rental Price" }, "custom_electricity_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Custom Electricity Price" }, "request": { "type": "object", "title": "Request" }, "result": { "type": "object", "title": "Result" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" } }, "type": "object", "required": [ "id", "region_id", "gpu_profile_id", "gpu_model", "total_mw", "usable_sqft", "cooling_type", "workload_type", "redundancy_mode", "utilization_rate" ], "title": "CalculationRecordOut" }, "CapacityMapCellOut": { "properties": { "power_multiplier": { "type": "number", "title": "Power Multiplier" }, "area_multiplier": { "type": "number", "title": "Area Multiplier" }, "power_mw": { "type": "number", "title": "Power Mw" }, "area_sqft": { "type": "number", "title": "Area Sqft" }, "bottleneck": { "type": "string", "enum": [ "power", "area", "balanced" ], "title": "Bottleneck" }, "deployable_units": { "type": "integer", "title": "Deployable Units" }, "is_current": { "type": "boolean", "title": "Is Current", "default": false } }, "type": "object", "required": [ "power_multiplier", "area_multiplier", "power_mw", "area_sqft", "bottleneck", "deployable_units" ], "title": "CapacityMapCellOut" }, "CapacityOverridesIn": { "properties": { "facility_power_mw": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Facility Power Mw" }, "non_it_overhead_mw": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Non It Overhead Mw" }, "ai_networking_mw": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Ai Networking Mw" }, "base_infrastructure_mw": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Base Infrastructure Mw" }, "utilization_buffer_mw": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Utilization Buffer Mw" }, "gpu_compute_power_mw": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Gpu Compute Power Mw" }, "estimated_gpus": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Estimated Gpus" } }, "type": "object", "title": "CapacityOverridesIn" }, "CapacityResultOut": { "properties": { "total_facility_kw": { "type": "number", "title": "Total Facility Kw" }, "cooling_overhead_kw": { "type": "number", "title": "Cooling Overhead Kw" }, "it_load_kw": { "type": "number", "title": "It Load Kw" }, "ai_networking_kw": { "type": "number", "title": "Ai Networking Kw" }, "ai_networking_ratio": { "type": "number", "title": "Ai Networking Ratio" }, "critical_infra_kw": { "type": "number", "title": "Critical Infra Kw" }, "critical_infra_ratio": { "type": "number", "title": "Critical Infra Ratio" }, "redundancy_reserve_kw": { "type": "number", "title": "Redundancy Reserve Kw" }, "gpu_compute_kw": { "type": "number", "title": "Gpu Compute Kw" }, "power_per_gpu_kw": { "type": "number", "title": "Power Per Gpu Kw" }, "power_limit_racks": { "type": "integer", "title": "Power Limit Racks" }, "area_limit_racks": { "type": "integer", "title": "Area Limit Racks" }, "max_racks": { "type": "integer", "title": "Max Racks" }, "bottleneck": { "type": "string", "enum": [ "power", "area" ], "title": "Bottleneck" }, "total_gpus": { "type": "integer", "title": "Total Gpus" }, "effective_utilization_rate": { "type": "number", "title": "Effective Utilization Rate" }, "est_customers_low": { "type": "integer", "title": "Est Customers Low" }, "est_customers_high": { "type": "integer", "title": "Est Customers High" } }, "type": "object", "required": [ "total_facility_kw", "cooling_overhead_kw", "it_load_kw", "ai_networking_kw", "ai_networking_ratio", "critical_infra_kw", "critical_infra_ratio", "redundancy_reserve_kw", "gpu_compute_kw", "power_per_gpu_kw", "power_limit_racks", "area_limit_racks", "max_racks", "bottleneck", "total_gpus", "effective_utilization_rate", "est_customers_low", "est_customers_high" ], "title": "CapacityResultOut" }, "CostBlendedBody": { "properties": { "num_per_page": { "type": "integer", "maximum": 100, "minimum": 1, "title": "Num Per Page", "description": "how many records will be return per one page, value score in 1 to 100，default value is 50", "default": 50 }, "page_num": { "type": "integer", "minimum": 1, "title": "Page Num", "description": "the page index number, default value is 1", "default": 1 }, "input_ratio": { "type": "number", "maximum": 1, "minimum": 0, "title": "Input Ratio", "description": "set the input ratio in the workload distribution, value between 0 and 1 with max 2 decimal places", "default": 0.5 }, "output_ratio": { "type": "number", "maximum": 1, "minimum": 0, "title": "Output Ratio", "description": "set the output ratio in the workload distribution, value between 0 and 1 with max 2 decimal places", "default": 0.5 }, "model_name": { "type": "string", "title": "Model Name", "description": "model developer name should be map the developer name" }, "developer": { "type": "string", "title": "Developer", "description": "model developer name, such as OpenAI, Anthropic, Google, DeepSeek etc" } }, "type": "object", "required": [ "model_name", "developer" ], "title": "CostBlendedBody", "description": "It is the optional parameter for setting the pagination.\nIf nothing is set it will use the default value." }, "CustomerPortalSessionRequestBody": { "properties": { "return_url": { "type": "string", "title": "Return Url", "description": "The return url of frontend after customer portal operation" } }, "type": "object", "required": [ "return_url" ], "title": "CustomerPortalSessionRequestBody" }, "DashboardInsightsOut": { "properties": { "location_factor": { "$ref": "#/components/schemas/LocationFactorResultOut" }, "redundancy": { "$ref": "#/components/schemas/RedundancyResultOut" }, "power_train": { "$ref": "#/components/schemas/PowerTrainResultOut" }, "heatmap": { "items": { "$ref": "#/components/schemas/HeatmapCellOut" }, "type": "array", "title": "Heatmap" }, "break_even": { "$ref": "#/components/schemas/BreakEvenResultOut" }, "capacity_map": { "items": { "$ref": "#/components/schemas/CapacityMapCellOut" }, "type": "array", "title": "Capacity Map" } }, "type": "object", "required": [ "location_factor", "redundancy", "power_train", "heatmap", "break_even", "capacity_map" ], "title": "DashboardInsightsOut" }, "DataBody": { "properties": { "id": { "type": "integer", "title": "Id", "description": "id as string convert from int" } }, "type": "object", "required": [ "id" ], "title": "DataBody" }, "FilterItem": { "type": "object", "title": "FilterItem", "description": "It is used to represent each filter condition in the filter.\nEach filter condition must be a dictionary containing a single key-value pair." }, "FinancialResultOut": { "properties": { "rental_price_per_gpu_hr": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Rental Price Per Gpu Hr" }, "gpu_new_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Gpu New Price" }, "gpu_new_price_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gpu New Price Source" }, "gpu_new_price_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gpu New Price Date" }, "gpu_new_price_sample_count": { "type": "integer", "title": "Gpu New Price Sample Count", "default": 0 }, "site_scale": { "type": "string", "enum": [ "small", "mid", "large", "hyperscale" ], "title": "Site Scale" }, "gpu_density_class": { "type": "string", "enum": [ "standard", "high", "ultra-high", "extreme" ], "title": "Gpu Density Class" }, "cost_assumption_basis": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cost Assumption Basis" }, "it_infrastructure_multiplier": { "type": "number", "title": "It Infrastructure Multiplier" }, "staffing_opex_per_gpu_month": { "type": "number", "title": "Staffing Opex Per Gpu Month" }, "depreciation_period_months": { "type": "integer", "title": "Depreciation Period Months" }, "total_it_cost_per_gpu": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total It Cost Per Gpu" }, "depreciation_cost_per_gpu_month": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Depreciation Cost Per Gpu Month" }, "depreciation_cost_month": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Depreciation Cost Month" }, "staffing_operations_cost_month": { "type": "number", "title": "Staffing Operations Cost Month" }, "electricity_price_kwh": { "type": "number", "title": "Electricity Price Kwh" }, "max_revenue_hr": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Max Revenue Hr" }, "avg_revenue_hr": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Avg Revenue Hr" }, "max_revenue_month": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Max Revenue Month" }, "avg_revenue_month": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Avg Revenue Month" }, "gpu_payback_months": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Gpu Payback Months" }, "power_cost_month": { "type": "number", "title": "Power Cost Month" }, "total_cost_month": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Cost Month" }, "max_profit_month": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Max Profit Month" }, "avg_profit_month": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Avg Profit Month" }, "margin_max": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Margin Max" }, "margin_avg": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Margin Avg" } }, "type": "object", "required": [ "site_scale", "gpu_density_class", "it_infrastructure_multiplier", "staffing_opex_per_gpu_month", "depreciation_period_months", "staffing_operations_cost_month", "electricity_price_kwh", "power_cost_month" ], "title": "FinancialResultOut" }, "ForwardHistoryRequest": { "properties": { "gpu": { "type": "string", "maxLength": 20, "minLength": 1, "title": "Gpu", "description": "GPU type, so far we only support H100, A100, B200 series type, you can just input 'H100', 'A100', 'B200' for querying." }, "term": { "type": "integer", "maximum": 36, "minimum": 0, "title": "Term", "description": "inquired is the forward term, 0 means near-term, 1 means 1-month forward, 2 means 2-month forward, etc." }, "starting_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Starting Date", "description": "History range starting date (inclusive), should be: YYYY-MM-DD. Must be provided together with ending_date, and can not be combined with latest_days." }, "ending_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Ending Date", "description": "History range ending date (inclusive), should be: YYYY-MM-DD, should not be greater than today. Must be provided together with starting_date, and can not be combined with latest_days." }, "latest_days": { "type": "integer", "title": "Latest Days", "description": "Alternative to starting_date/ending_date, can not be combined with them. 0 = not set (use starting_date/ending_date instead); N > 0 = the most recent N days of data ending at the latest available date (e.g. 30 for the '30D' chip, 365 for '1Y'); -1 = ALL (every available date); -2 = YTD (from Jan 1st of the year of the latest available date through that date).", "default": 0 } }, "type": "object", "required": [ "gpu", "term" ], "title": "ForwardHistoryRequest" }, "ForwardRequest": { "properties": { "gpu": { "type": "string", "maxLength": 20, "minLength": 1, "title": "Gpu", "description": "GPU type, so far we only support H100, A100, B200 series type, you can just input 'H100', 'A100', 'B200' for querying." }, "forward_date": { "type": "string", "format": "date", "title": "Forward Date", "description": "The forward date you want to query, should be: YYYY-MM-DD, if not provided, it will be today" } }, "type": "object", "required": [ "gpu", "forward_date" ], "title": "ForwardRequest" }, "GPUCarbonIntensityRequestBody": { "properties": { "gpu_slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gpu Slug", "description": "GPU Slug" }, "gpu_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gpu Name", "description": "GPU full name. if GPU slug is filled in, full name will be overridden; if GPU slug is not provided, full name shall be required." }, "hours_used": { "type": "number", "exclusiveMinimum": 0, "title": "Hours Used", "description": "GPU used in hours, should be greater then 0" }, "zipcode": { "type": "string", "title": "Zipcode", "description": "Zip code of data center" }, "country_code": { "type": "string", "title": "Country Code", "description": "County code of data center, represented in ISO 3166-1 alpha 2, e.g., 'US' representing United States" } }, "type": "object", "required": [ "hours_used", "zipcode", "country_code" ], "title": "GPUCarbonIntensityRequestBody" }, "GenerateTokenBody": { "properties": { "client_id": { "type": "string", "title": "Client Id", "description": "application client id" }, "client_secret": { "type": "string", "title": "Client Secret", "description": "application client secret" } }, "type": "object", "required": [ "client_id", "client_secret" ], "title": "GenerateTokenBody" }, "GeographyDistributionRequest": { "properties": { "provider_classes": { "anyOf": [ { "items": { "type": "string", "enum": [ "hyperscaler", "neocloud" ] }, "type": "array" }, { "type": "null" } ], "title": "Provider Classes" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "start_quarter": { "type": "string", "title": "Start Quarter", "default": "2025-Q1" }, "end_quarter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Quarter" }, "regions": { "anyOf": [ { "items": { "type": "string", "enum": [ "Africa", "Asia-Pacific", "Europe", "Latin America", "Middle East", "Nordics", "North America" ] }, "type": "array" }, { "type": "null" } ], "title": "Regions" }, "gpu_family": { "anyOf": [ { "type": "string", "enum": [ "A100", "H100", "B200" ] }, { "type": "null" } ], "title": "Gpu Family" } }, "type": "object", "title": "GeographyDistributionRequest" }, "GpuProfileInfoRequest": { "properties": { "profile_id": { "type": "integer", "exclusiveMinimum": 0, "title": "Profile Id" } }, "type": "object", "required": [ "profile_id" ], "title": "GpuProfileInfoRequest" }, "GpuProfileOut": { "properties": { "id": { "type": "integer", "title": "Id" }, "model": { "type": "string", "title": "Model" }, "product_slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Product Slug" }, "display_name": { "type": "string", "title": "Display Name" }, "power_kw": { "type": "number", "title": "Power Kw" }, "tdp_per_gpu_w": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Tdp Per Gpu W" }, "gpus_per_server": { "type": "integer", "title": "Gpus Per Server" }, "sqft_per_rack": { "type": "number", "title": "Sqft Per Rack" }, "min_cooling": { "type": "string", "enum": [ "air", "liquid", "immersion" ], "title": "Min Cooling" }, "required_redundancy_mode": { "anyOf": [ { "type": "string", "enum": [ "none", "tier3_n_plus_1", "tier3_2n", "three_n_over_two" ] }, { "type": "null" } ], "title": "Required Redundancy Mode" }, "source": { "type": "string", "title": "Source" }, "active": { "type": "boolean", "title": "Active" } }, "type": "object", "required": [ "id", "model", "display_name", "power_kw", "gpus_per_server", "sqft_per_rack", "min_cooling", "source", "active" ], "title": "GpuProfileOut" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "HeatmapCellOut": { "properties": { "density_multiplier": { "type": "number", "title": "Density Multiplier" }, "density_label": { "type": "string", "title": "Density Label" }, "utilization_pct": { "type": "integer", "title": "Utilization Pct" }, "stress_score": { "type": "number", "title": "Stress Score" }, "level": { "type": "string", "enum": [ "low", "moderate", "high", "critical" ], "title": "Level" } }, "type": "object", "required": [ "density_multiplier", "density_label", "utilization_pct", "stress_score", "level" ], "title": "HeatmapCellOut" }, "HistoricalRecordOut": { "properties": { "inputs": { "$ref": "#/components/schemas/InputsSummaryOut" }, "capacity": { "$ref": "#/components/schemas/CapacityResultOut" }, "financials": { "$ref": "#/components/schemas/FinancialResultOut" }, "insights": { "$ref": "#/components/schemas/DashboardInsightsOut" }, "alerts": { "items": { "$ref": "#/components/schemas/AlertOut" }, "type": "array", "title": "Alerts" }, "calculation_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Calculation Id" }, "historical_record_id": { "type": "integer", "title": "Historical Record Id" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "request": { "type": "object", "title": "Request" } }, "type": "object", "required": [ "inputs", "capacity", "financials", "insights", "alerts", "historical_record_id" ], "title": "HistoricalRecordOut" }, "HistoricalRecordsRequest": { "properties": { "limit": { "type": "integer", "maximum": 10, "minimum": 1, "title": "Limit", "default": 10 }, "order": { "type": "string", "enum": [ "asc", "desc" ], "title": "Order", "default": "desc" } }, "type": "object", "title": "HistoricalRecordsRequest" }, "HistoryPriceBase": { "properties": { "num_per_page": { "type": "integer", "maximum": 100, "minimum": 1, "title": "Num Per Page", "description": "how many records will be return per one page, value score in 1 to 100，default value is 50", "default": 50 }, "page_num": { "type": "integer", "minimum": 1, "title": "Page Num", "description": "the page index number, default value is 1", "default": 1 }, "product_id": { "type": "integer", "maximum": 99999999, "minimum": 10000000, "title": "Product Id", "description": "product id should be 8 digits" }, "start_date": { "type": "string", "maxLength": 10, "minLength": 10, "title": "Start Date", "description": "price from start date，YYYY-MM-DD", "examples": [ "2024-10-01" ] }, "end_date": { "type": "string", "maxLength": 10, "minLength": 10, "title": "End Date", "description": "price to end date, YYYY-MM-DD", "examples": [ "2024-10-31" ] }, "price_type": { "type": "integer", "title": "Price Type", "description": "must be one of the values [-2, -1, 0, 1, 3, 6, 12, 24, 100, 101, 102] \t\n-2: Demand Driven,\n-1: Rental Spot,\n0: Rental On-Demand,\n1: Rental Reserved 1 month,\n3: Rental Reserved 3 month,\n6: Rental Reserved 6 month,\n12: Rental Reserved 1 year,\n24: 'Rental Reserved 2 year',\n36: 'Rental Reserved 3 year',\n60: 'Rental Reserved 5 year',\n100: Retail New,\n101: Retail Refurbished,\n102: Retail Used" }, "country": { "anyOf": [ { "type": "string", "maxLength": 2 }, { "type": "null" } ], "title": "Country", "description": "the ISO country codes 2-digit string.", "default": "" }, "provider_source_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider Source Type", "description": "provider source type include 'Marketplace', 'Neocloud'", "default": "" } }, "type": "object", "required": [ "product_id", "start_date", "end_date", "price_type" ], "title": "HistoryPriceBase" }, "IndexRequest": { "properties": { "gpu": { "type": "string", "maxLength": 20, "minLength": 1, "title": "Gpu", "description": "GPU type, so far we only support H100, A100, B200, Mi300x series type, you can just input 'H100', 'A100', 'B200', 'Mi300x' for querying." }, "index_version": { "anyOf": [ { "type": "string", "maxLength": 5, "minLength": 1 }, { "type": "null" } ], "title": "Index Version", "description": "The value should be hs or neo, hs is short for HyperScaler, neo is short for NeoCloud", "default": "neo" }, "starting_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Starting Date", "description": "The start date you want to query, format: YYYY-MM-DD, if not provided, it will be today" }, "ending_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Ending Date", "description": "The ending date you want to query, format: YYYY-MM-DD, if not provided, it will be today" } }, "type": "object", "required": [ "gpu" ], "title": "IndexRequest" }, "InputsSummaryOut": { "properties": { "total_mw": { "type": "number", "title": "Total Mw" }, "usable_sqft": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Usable Sqft" }, "region": { "$ref": "#/components/schemas/RegionInfoOut" }, "gpu_model": { "type": "string", "title": "Gpu Model" }, "gpu_product_slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gpu Product Slug" }, "power_per_gpu_kw": { "type": "number", "title": "Power Per Gpu Kw" }, "workload_type": { "type": "string", "enum": [ "training", "inference", "both" ], "title": "Workload Type" }, "utilization_rate": { "type": "number", "title": "Utilization Rate" }, "pue_used": { "type": "number", "title": "Pue Used" }, "cooling_type": { "type": "string", "enum": [ "air", "liquid", "immersion" ], "title": "Cooling Type" }, "redundancy_mode": { "type": "string", "enum": [ "none", "tier3_n_plus_1", "tier3_2n", "three_n_over_two" ], "title": "Redundancy Mode" }, "capacity_overrides": { "anyOf": [ { "$ref": "#/components/schemas/CapacityOverridesIn" }, { "type": "null" } ] } }, "type": "object", "required": [ "total_mw", "region", "gpu_model", "power_per_gpu_kw", "workload_type", "utilization_rate", "pue_used", "cooling_type", "redundancy_mode" ], "title": "InputsSummaryOut" }, "InstancePriceBase": { "properties": { "num_per_page": { "type": "integer", "maximum": 100, "minimum": 1, "title": "Num Per Page", "description": "how many records will be return per one page, value score in 1 to 100，default value is 50", "default": 50 }, "page_num": { "type": "integer", "minimum": 1, "title": "Page Num", "description": "the page index number, default value is 1", "default": 1 }, "product_id": { "type": "integer", "title": "Product Id", "description": "product id of price history. Must be an 8-digit integer.", "default": 19112600 }, "provider": { "type": "string", "title": "Provider", "description": "provider" }, "country": { "anyOf": [ { "type": "string", "maxLength": 2 }, { "type": "null" } ], "title": "Country", "description": "the ISO country codes 2-digit string.", "default": "" }, "price_type": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Price Type", "description": "must be one of the values [-2, -1, 0, 1, 3, 6, 12, 24, 36, 60, 100, 101, 102] \t\n-2: Demand Driven,\n-1: Rental Spot,\n0: Rental On-Demand,\n1: Rental Reserved 1 month,\n3: Rental Reserved 3 month,\n6: Rental Reserved 6 month,\n12: Rental Reserved 1 year,\n24: 'Rental Reserved 2 year',\n36: 'Rental Reserved 3 year',\n60: 'Rental Reserved 5 year',\n100: Retail New,\n101: Retail Refurbished,\n102: Retail Used", "default": 0 } }, "type": "object", "title": "InstancePriceBase", "description": "It is the optional parameter for setting the pagination.\nIf nothing is set it will use the default value." }, "LatestInsightsRequest": { "properties": { "index": { "type": "string", "title": "Index", "description": "Insight index type, such as gpu or token.", "default": "gpu" }, "object": { "type": "string", "title": "Object", "description": "Object key, such as a100, h100, b200, or expenditure." } }, "type": "object", "required": [ "object" ], "title": "LatestInsightsRequest" }, "LatestPriceBase": { "properties": { "num_per_page": { "type": "integer", "maximum": 100, "minimum": 1, "title": "Num Per Page", "description": "how many records will be return per one page, value score in 1 to 100，default value is 50", "default": 50 }, "page_num": { "type": "integer", "minimum": 1, "title": "Page Num", "description": "the page index number, default value is 1", "default": 1 }, "keyword": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Keyword", "description": "keyword for query conditions which use for search.", "default": "" }, "product_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Product Id", "description": "product id of price history.", "default": 0 }, "country": { "anyOf": [ { "type": "string", "maxLength": 2 }, { "type": "null" } ], "title": "Country", "description": "the ISO country codes 2-digit string.", "default": "" }, "price_type": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Price Type", "description": "must be one of the values [-2, -1, 0, 1, 3, 6, 12, 24, 100, 101, 102] \t\n-2: Demand Driven,\n-1: Rental Spot,\n0: Rental On-Demand,\n1: Rental Reserved 1 month,\n3: Rental Reserved 3 month,\n6: Rental Reserved 6 month,\n12: Rental Reserved 1 year,\n24: 'Rental Reserved 2 year',\n100: Retail New,\n101: Retail Refurbished,\n102: Retail Used" } }, "type": "object", "title": "LatestPriceBase" }, "LocationFactorResultOut": { "properties": { "ashrae_basis": { "type": "string", "title": "Ashrae Basis" }, "climate_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Climate Source" }, "avg_temp_c": { "type": "number", "title": "Avg Temp C" }, "design_dry_bulb_c": { "type": "number", "title": "Design Dry Bulb C" }, "design_wet_bulb_c": { "type": "number", "title": "Design Wet Bulb C" }, "avg_humidity_pct": { "type": "number", "title": "Avg Humidity Pct" }, "cooling_degree_days": { "type": "integer", "title": "Cooling Degree Days" }, "cooling_strategy": { "type": "string", "title": "Cooling Strategy" }, "free_cooling_potential": { "type": "string", "enum": [ "low", "medium", "high" ], "title": "Free Cooling Potential" }, "humidity_risk": { "type": "string", "enum": [ "low", "medium", "high" ], "title": "Humidity Risk" }, "base_pue": { "type": "number", "title": "Base Pue" }, "effective_pue": { "type": "number", "title": "Effective Pue" }, "pue_delta": { "type": "number", "title": "Pue Delta" }, "chiller_penalty_pct": { "type": "number", "title": "Chiller Penalty Pct" }, "humidity_penalty_pct": { "type": "number", "title": "Humidity Penalty Pct" }, "free_cooling_credit_pct": { "type": "number", "title": "Free Cooling Credit Pct" }, "thermal_stress_score": { "type": "number", "title": "Thermal Stress Score" }, "thermal_stress_level": { "type": "string", "enum": [ "low", "moderate", "high", "critical" ], "title": "Thermal Stress Level" }, "pue_override": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Pue Override" } }, "type": "object", "required": [ "ashrae_basis", "avg_temp_c", "design_dry_bulb_c", "design_wet_bulb_c", "avg_humidity_pct", "cooling_degree_days", "cooling_strategy", "free_cooling_potential", "humidity_risk", "base_pue", "effective_pue", "pue_delta", "chiller_penalty_pct", "humidity_penalty_pct", "free_cooling_credit_pct", "thermal_stress_score", "thermal_stress_level" ], "title": "LocationFactorResultOut" }, "LoginBody": { "properties": { "email": { "type": "string", "format": "email", "title": "Email", "description": "email" }, "password": { "type": "string", "title": "Password" } }, "type": "object", "required": [ "email", "password" ], "title": "LoginBody" }, "OrderByItem": { "type": "object", "title": "OrderByItem", "description": "It is used to represent each sorting condition in the order_by.\nEach sorting condition must be a dictionary containing a single key-value pair, and the value can only be \"asc\" or \"desc\"." }, "PaginateBase": { "properties": { "num_per_page": { "type": "integer", "maximum": 100, "minimum": 1, "title": "Num Per Page", "description": "how many records will be return per one page, value score in 1 to 100，default value is 50", "default": 50 }, "page_num": { "type": "integer", "minimum": 1, "title": "Page Num", "description": "the page index number, default value is 1", "default": 1 } }, "type": "object", "title": "PaginateBase", "description": "It is the optional parameter for setting the pagination.\nIf nothing is set it will use the default value." }, "PartnerLatestPriceBase": { "properties": { "num_per_page": { "type": "integer", "maximum": 100, "minimum": 1, "title": "Num Per Page", "description": "how many records will be return per one page, value score in 1 to 100，default value is 50", "default": 50 }, "page_num": { "type": "integer", "minimum": 1, "title": "Page Num", "description": "the page index number, default value is 1", "default": 1 }, "product_id": { "type": "integer", "title": "Product Id", "description": "product id of price history. Must be an 8-digit integer." }, "provider": { "type": "string", "title": "Provider", "description": "provider" }, "country": { "anyOf": [ { "type": "string", "maxLength": 2 }, { "type": "null" } ], "title": "Country", "description": "the ISO country codes 2-digit string.", "default": "" }, "price_type": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Price Type", "description": "must be one of the values [-2, -1, 0, 1, 3, 6, 12, 24, 36, 60, 100, 101, 102] \t\n-2: Demand Driven,\n-1: Rental Spot,\n0: Rental On-Demand,\n1: Rental Reserved 1 month,\n3: Rental Reserved 3 month,\n6: Rental Reserved 6 month,\n12: Rental Reserved 1 year,\n24: 'Rental Reserved 2 year',\n36: 'Rental Reserved 3 year',\n60: 'Rental Reserved 5 year',\n100: Retail New,\n101: Retail Refurbished,\n102: Retail Used", "default": 0 } }, "type": "object", "required": [ "product_id" ], "title": "PartnerLatestPriceBase", "description": "It is the optional parameter for setting the pagination.\nIf nothing is set it will use the default value." }, "PowerTrainResultOut": { "properties": { "workload_type": { "type": "string", "enum": [ "training", "inference", "both" ], "title": "Workload Type" }, "workload_policy_mode": { "type": "string", "enum": [ "none", "tier3_n_plus_1", "tier3_2n", "three_n_over_two" ], "title": "Workload Policy Mode" }, "workload_policy_label": { "type": "string", "title": "Workload Policy Label" }, "workload_policy_basis": { "type": "string", "title": "Workload Policy Basis" }, "selected_mode": { "type": "string", "enum": [ "none", "tier3_n_plus_1", "tier3_2n", "three_n_over_two" ], "title": "Selected Mode" }, "selected_label": { "type": "string", "title": "Selected Label" }, "platform_floor_mode": { "anyOf": [ { "type": "string", "enum": [ "none", "tier3_n_plus_1", "tier3_2n", "three_n_over_two" ] }, { "type": "null" } ], "title": "Platform Floor Mode" }, "platform_floor_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Platform Floor Label" }, "reserve_pct": { "type": "number", "title": "Reserve Pct" }, "reserve_kw": { "type": "number", "title": "Reserve Kw" }, "usable_capacity_pct": { "type": "number", "title": "Usable Capacity Pct" }, "topology_summary": { "type": "string", "title": "Topology Summary" }, "status": { "type": "string", "enum": [ "workload_aligned", "platform_locked", "customized" ], "title": "Status" }, "status_message": { "type": "string", "title": "Status Message" } }, "type": "object", "required": [ "workload_type", "workload_policy_mode", "workload_policy_label", "workload_policy_basis", "selected_mode", "selected_label", "reserve_pct", "reserve_kw", "usable_capacity_pct", "topology_summary", "status", "status_message" ], "title": "PowerTrainResultOut" }, "PredictBody": { "properties": { "gpu_name": { "type": "string", "maxLength": 20, "minLength": 1, "title": "Gpu Name", "description": "GPU Name: example. A100 PCIE" }, "type": { "type": "integer", "title": "Type", "description": "must be one of the values [0, 1, 2] \t\n0: on-Demand,\n1: Interrupt,\n2: reserved" }, "geolocation": { "type": "string", "maxLength": 40, "minLength": 1, "title": "Geolocation", "description": "example: California, US" }, "cpu_platform": { "type": "string", "maxLength": 20, "minLength": 1, "title": "Cpu Platform", "description": "CPU platform: example. AMD" }, "cpu_cores_effective": { "type": "integer", "maximum": 1024, "minimum": 1, "title": "Cpu Cores Effective", "description": "CPU Cores (Effective)", "default": 16 }, "cpu_ram_gb": { "type": "number", "maximum": 1024, "minimum": 1, "title": "Cpu Ram Gb", "description": "CPU RAM(GB)", "default": 36 }, "ram_gb": { "type": "number", "maximum": 512, "minimum": 1, "title": "Ram Gb", "description": "GPU RAM(GB)", "default": 40 } }, "type": "object", "required": [ "gpu_name", "type", "geolocation", "cpu_platform" ], "title": "PredictBody" }, "PriceTrendBase": { "properties": { "product_slug": { "type": "string", "maxLength": 50, "title": "Product Slug", "description": "product slug, ex: n-h100-pcie-80g" }, "days": { "type": "integer", "maximum": 90, "minimum": 1, "title": "Days", "description": "number of days for price trend, default is 7 days", "default": 7 }, "country": { "anyOf": [ { "type": "string", "maxLength": 2 }, { "type": "null" } ], "title": "Country", "description": "the ISO country codes 2-digit string.", "default": "" } }, "type": "object", "required": [ "product_slug" ], "title": "PriceTrendBase" }, "ProductSlugBase": { "properties": { "product_slug": { "type": "string", "maxLength": 50, "title": "Product Slug", "description": "product slug, ex: n-h100-pcie-80g" } }, "type": "object", "required": [ "product_slug" ], "title": "ProductSlugBase", "description": "It is the optional parameter for setting the pagination.\nIf nothing is set it will use the default value." }, "QuarterlyTrendsRequest": { "properties": { "provider_classes": { "anyOf": [ { "items": { "type": "string", "enum": [ "hyperscaler", "neocloud" ] }, "type": "array" }, { "type": "null" } ], "title": "Provider Classes" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "start_quarter": { "type": "string", "title": "Start Quarter", "default": "2025-Q1" }, "end_quarter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Quarter" }, "regions": { "anyOf": [ { "items": { "type": "string", "enum": [ "Africa", "Asia-Pacific", "Europe", "Latin America", "Middle East", "Nordics", "North America" ] }, "type": "array" }, { "type": "null" } ], "title": "Regions" }, "gpu_family": { "anyOf": [ { "type": "string", "enum": [ "A100", "H100", "B200" ] }, { "type": "null" } ], "title": "Gpu Family" } }, "type": "object", "title": "QuarterlyTrendsRequest" }, "RamRequest": { "properties": { "ram": { "type": "string", "maxLength": 20, "minLength": 1, "title": "Ram", "description": "RAM type, so far we only support GDDR6, you can just input 'GDDR6' for querying." }, "index_version": { "anyOf": [ { "type": "string", "maxLength": 20, "minLength": 1 }, { "type": "null" } ], "title": "Index Version", "description": "default is WAVG_v1. We will support more index version in the future", "default": "WAVG_v1" }, "starting_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Starting Date", "description": "The start date you want to query, format: YYYY-MM-DD, if not provided, it will be today" }, "ending_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Ending Date", "description": "The ending date you want to query, format: YYYY-MM-DD, if not provided, it will be today" } }, "type": "object", "required": [ "ram" ], "title": "RamRequest" }, "RedundancyResultOut": { "properties": { "enabled": { "type": "boolean", "title": "Enabled" }, "mode": { "type": "string", "enum": [ "none", "tier3_n_plus_1", "tier3_2n", "three_n_over_two" ], "title": "Mode" }, "reserve_pct": { "type": "number", "title": "Reserve Pct" }, "reserve_kw": { "type": "number", "title": "Reserve Kw" }, "label": { "type": "string", "title": "Label" }, "mandatory": { "type": "boolean", "title": "Mandatory", "default": false }, "policy_basis": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Policy Basis" } }, "type": "object", "required": [ "enabled", "mode", "reserve_pct", "reserve_kw", "label" ], "title": "RedundancyResultOut" }, "RegionInfoOut": { "properties": { "country": { "type": "string", "title": "Country" }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City" }, "climate_zone": { "type": "string", "title": "Climate Zone" } }, "type": "object", "required": [ "country", "climate_zone" ], "title": "RegionInfoOut" }, "RegionInfoRequest": { "properties": { "region_id": { "type": "integer", "exclusiveMinimum": 0, "title": "Region Id" } }, "type": "object", "required": [ "region_id" ], "title": "RegionInfoRequest" }, "RegionOut": { "properties": { "id": { "type": "integer", "title": "Id" }, "country_code": { "type": "string", "title": "Country Code" }, "country_name": { "type": "string", "title": "Country Name" }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City" }, "climate_zone": { "type": "string", "enum": [ "cold", "temperate", "tropical" ], "title": "Climate Zone" }, "pue_min": { "type": "number", "title": "Pue Min" }, "pue_max": { "type": "number", "title": "Pue Max" }, "pue_default": { "type": "number", "title": "Pue Default" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "electricity_price_kwh": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Electricity Price Kwh" }, "avg_temp_c": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Avg Temp C" }, "max_temp_c": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Max Temp C" }, "avg_humidity_pct": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Avg Humidity Pct" }, "wet_bulb_temp_c": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Wet Bulb Temp C" }, "cooling_degree_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Cooling Degree Days" }, "climate_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Climate Source" } }, "type": "object", "required": [ "id", "country_code", "country_name", "climate_zone", "pue_min", "pue_max", "pue_default" ], "title": "RegionOut" }, "RegionalTrendsRequest": { "properties": { "provider_classes": { "anyOf": [ { "items": { "type": "string", "enum": [ "hyperscaler", "neocloud" ] }, "type": "array" }, { "type": "null" } ], "title": "Provider Classes" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "start_quarter": { "type": "string", "title": "Start Quarter", "default": "2025-Q1" }, "end_quarter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Quarter" }, "regions": { "anyOf": [ { "items": { "type": "string", "enum": [ "US East", "US West", "Canada", "US Unspecified", "Nordics", "Europe", "Middle East", "Asia-Pacific", "Latin America", "Africa" ] }, "type": "array" }, { "type": "null" } ], "title": "Regions" }, "gpu_family": { "type": "string", "enum": [ "A100", "H100", "B200" ], "title": "Gpu Family" } }, "type": "object", "required": [ "gpu_family" ], "title": "RegionalTrendsRequest" }, "RentalPriceLookupOut": { "properties": { "product_slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Product Slug" }, "gpu_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gpu Name" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "type": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Type" }, "provider_source_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider Source Type" }, "avg_price_gpu_hr": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Avg Price Gpu Hr" }, "sample_count": { "type": "integer", "title": "Sample Count" }, "matched_term": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Matched Term" }, "country_scope": { "type": "string", "title": "Country Scope", "default": "none" }, "match_mode": { "type": "string", "title": "Match Mode", "default": "none" }, "sources": { "items": { "type": "string" }, "type": "array", "title": "Sources" }, "types": { "items": { "type": "integer" }, "type": "array", "title": "Types" }, "provider_source_types": { "items": { "type": "string" }, "type": "array", "title": "Provider Source Types" }, "options": { "items": { "$ref": "#/components/schemas/RentalPriceOptionOut" }, "type": "array", "title": "Options" } }, "type": "object", "required": [ "sample_count" ], "title": "RentalPriceLookupOut" }, "RentalPriceLookupRequest": { "properties": { "product_slug": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ], "title": "Product Slug" }, "gpu_name": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ], "title": "Gpu Name" }, "country": { "anyOf": [ { "type": "string", "maxLength": 32 }, { "type": "null" } ], "title": "Country" }, "source": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ], "title": "Source" }, "type": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Type" }, "provider_source_type": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ], "title": "Provider Source Type" } }, "type": "object", "title": "RentalPriceLookupRequest" }, "RentalPriceOptionOut": { "properties": { "option_key": { "type": "string", "title": "Option Key" }, "label": { "type": "string", "title": "Label" }, "avg_price_gpu_hr": { "type": "number", "title": "Avg Price Gpu Hr" }, "sample_count": { "type": "integer", "title": "Sample Count" }, "rental_type": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Rental Type" }, "provider_source_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider Source Type" }, "sources": { "items": { "type": "string" }, "type": "array", "title": "Sources" }, "is_default": { "type": "boolean", "title": "Is Default", "default": false } }, "type": "object", "required": [ "option_key", "label", "avg_price_gpu_hr", "sample_count" ], "title": "RentalPriceOptionOut" }, "RentalPriceOut": { "properties": { "product_slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Product Slug" }, "gpu_names": { "items": { "type": "string" }, "type": "array", "title": "Gpu Names" }, "avg_price_gpu": { "type": "number", "title": "Avg Price Gpu" }, "min_price_gpu": { "type": "number", "title": "Min Price Gpu" }, "max_price_gpu": { "type": "number", "title": "Max Price Gpu" }, "sources": { "items": { "type": "string" }, "type": "array", "title": "Sources" }, "types": { "items": { "type": "integer" }, "type": "array", "title": "Types" }, "provider_source_types": { "items": { "type": "string" }, "type": "array", "title": "Provider Source Types" }, "sample_count": { "type": "integer", "title": "Sample Count" } }, "type": "object", "required": [ "gpu_names", "avg_price_gpu", "min_price_gpu", "max_price_gpu", "sources", "types", "provider_source_types", "sample_count" ], "title": "RentalPriceOut" }, "RentalPricesRequest": { "properties": { "product_slug": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ], "title": "Product Slug" }, "gpu_name": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ], "title": "Gpu Name" }, "country": { "anyOf": [ { "type": "string", "maxLength": 32 }, { "type": "null" } ], "title": "Country" }, "source": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ], "title": "Source" }, "type": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Type" }, "provider_source_type": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ], "title": "Provider Source Type" }, "limit": { "type": "integer", "maximum": 200, "minimum": 1, "title": "Limit", "default": 50 } }, "type": "object", "title": "RentalPricesRequest" }, "ResetPasswordBody": { "properties": { "email": { "type": "string", "format": "email", "title": "Email", "description": "email" }, "confirmation_code": { "type": "string", "title": "Confirmation Code" }, "new_password": { "type": "string", "title": "New Password" } }, "type": "object", "required": [ "email", "confirmation_code", "new_password" ], "title": "ResetPasswordBody" }, "SearchBody": { "properties": { "filter": { "items": { "$ref": "#/components/schemas/FilterItem" }, "type": "array", "title": "Filter", "description": "filter list, example: [{\"key1\": 2}, {\"key2\": \"2024/06/19-2026/06/03\"}]. A flat dict is also accepted, example: {\"key1\": 2, \"key2\": \"2024/06/19-2026/06/03\"}" }, "order_by": { "items": { "$ref": "#/components/schemas/OrderByItem" }, "type": "array", "title": "Order By", "description": "order by list, example: [{\"write_date\": \"desc\"}, {\"sequence_id\": \"asc\"}]. A flat dict is also accepted, example: {\"write_date\": \"desc\", \"sequence_id\": \"asc\"}" }, "paginate": { "$ref": "#/components/schemas/PaginateBase", "description": "Pagination" } }, "type": "object", "title": "SearchBody" }, "SourcePriceRequest": { "properties": { "gpu": { "type": "string", "maxLength": 20, "minLength": 1, "title": "Gpu", "description": "GPU type. Currently supported values: H100, A100, B200, Mi300x." }, "index_version": { "anyOf": [ { "type": "string", "maxLength": 5, "minLength": 1 }, { "type": "null" } ], "title": "Index Version", "description": "Must be 'hs' (HyperScaler) or 'neo' (NeoCloud).", "default": "neo" }, "index_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Index Date", "description": "The start date you want to query, format: YYYY-MM-DD, if not provided, it will be today" } }, "type": "object", "required": [ "gpu" ], "title": "SourcePriceRequest" }, "SubscriptionRequestBody": { "properties": { "price_id": { "type": "string", "title": "Price Id", "description": "The price id of the subscription" }, "success_url": { "type": "string", "title": "Success Url", "description": "The success url of frontend after the payment" }, "cancel_url": { "type": "string", "title": "Cancel Url", "description": "The cancel url of frontend after the payment" } }, "type": "object", "required": [ "price_id", "success_url", "cancel_url" ], "title": "SubscriptionRequestBody" }, "TemplateCreateRequest": { "properties": { "name": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Name" }, "request": { "$ref": "#/components/schemas/CalculateRequest" } }, "type": "object", "required": [ "name", "request" ], "title": "TemplateCreateRequest" }, "TemplateDeleteResponse": { "properties": { "template_id": { "type": "integer", "title": "Template Id" }, "deleted": { "type": "boolean", "title": "Deleted" } }, "type": "object", "required": [ "template_id", "deleted" ], "title": "TemplateDeleteResponse" }, "TemplateInfoRequest": { "properties": { "template_id": { "type": "integer", "exclusiveMinimum": 0, "title": "Template Id" } }, "type": "object", "required": [ "template_id" ], "title": "TemplateInfoRequest" }, "TemplateOut": { "properties": { "id": { "type": "integer", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "request": { "$ref": "#/components/schemas/CalculateRequest" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "required": [ "id", "name", "request" ], "title": "TemplateOut" }, "TokenIndexRequest": { "properties": { "token": { "type": "string", "maxLength": 60, "minLength": 1, "title": "Token", "description": "LLM token index type, such as open_expenditure or closed_expenditure." }, "index_version": { "anyOf": [ { "type": "string", "maxLength": 60, "minLength": 1 }, { "type": "null" } ], "title": "Index Version", "description": "Token index version, currently v1.", "default": "v1" }, "starting_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Starting Date", "description": "The start date you want to query, format: YYYY-MM-DD. If both dates are omitted, the API returns the most recent 7 valid data points." }, "ending_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Ending Date", "description": "The ending date you want to query, format: YYYY-MM-DD. If both dates are omitted, the API returns the most recent 7 valid data points." } }, "type": "object", "required": [ "token" ], "title": "TokenIndexRequest" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" }, "input": { "title": "Input" }, "ctx": { "type": "object", "title": "Context" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" }, "app__api__gpu__common__SpotPriceBase": { "properties": { "product_slug": { "type": "string", "maxLength": 50, "title": "Product Slug", "description": "product slug, ex: n-h100-pcie-80g" }, "country": { "anyOf": [ { "type": "string", "maxLength": 2 }, { "type": "null" } ], "title": "Country", "description": "the ISO country codes 2-digit string.", "default": "" } }, "type": "object", "required": [ "product_slug" ], "title": "SpotPriceBase", "description": "It is the optional parameter for setting the pagination.\nIf nothing is set it will use the default value." }, "app__api__gpu__country_price__FilterPriceBase": { "properties": { "num_per_page": { "type": "integer", "maximum": 100, "minimum": 1, "title": "Num Per Page", "description": "how many records will be return per one page, value score in 1 to 100，default value is 50", "default": 50 }, "page_num": { "type": "integer", "minimum": 1, "title": "Page Num", "description": "the page index number, default value is 1", "default": 1 }, "product_id": { "type": "integer", "maximum": 99999999, "minimum": 10000000, "title": "Product Id", "description": "product id should be 8 digits" }, "start_date": { "type": "string", "maxLength": 10, "minLength": 10, "title": "Start Date", "description": "price from start date，YYYY-MM-DD", "examples": [ "2024-10-01" ] }, "end_date": { "type": "string", "maxLength": 10, "minLength": 10, "title": "End Date", "description": "price to end date, YYYY-MM-DD", "examples": [ "2024-10-31" ] }, "price_type": { "type": "integer", "title": "Price Type", "description": "must be one of the values [-2, -1, 0, 1, 3, 6, 12, 24, 100, 101, 102] \t\n-2: Demand Driven,\n-1: Rental Spot,\n0: Rental On-Demand,\n1: Rental Reserved 1 month,\n3: Rental Reserved 3 month,\n6: Rental Reserved 6 month,\n12: Rental Reserved 1 year,\n24: 'Rental Reserved 2 year',\n36: 'Rental Reserved 3 year',\n60: 'Rental Reserved 5 year',\n100: Retail New,\n101: Retail Refurbished,\n102: Retail Used" }, "country": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Country", "description": "country list, the ISO country codes 2-digit string." }, "provider_source_type": { "type": "string", "title": "Provider Source Type", "description": "provider source type must be one of the values ['Average', 'Marketplace', 'Neocloud']" } }, "type": "object", "required": [ "product_id", "start_date", "end_date", "price_type", "provider_source_type" ], "title": "FilterPriceBase" }, "app__api__gpu__instance_price__FilterPriceBase": { "properties": { "num_per_page": { "type": "integer", "maximum": 100, "minimum": 1, "title": "Num Per Page", "description": "how many records will be return per one page, value score in 1 to 100，default value is 50", "default": 50 }, "page_num": { "type": "integer", "minimum": 1, "title": "Page Num", "description": "the page index number, default value is 1", "default": 1 }, "product_id": { "type": "integer", "maximum": 99999999, "minimum": 10000000, "title": "Product Id", "description": "product id should be 8 digits" }, "start_date": { "type": "string", "maxLength": 10, "minLength": 10, "title": "Start Date", "description": "price from start date，YYYY-MM-DD", "examples": [ "2024-10-01" ] }, "end_date": { "type": "string", "maxLength": 10, "minLength": 10, "title": "End Date", "description": "price to end date, YYYY-MM-DD", "examples": [ "2024-10-31" ] }, "price_type": { "type": "integer", "title": "Price Type", "description": "must be one of the values [-2, -1, 0, 1, 3, 6, 12, 24, 100, 101, 102] \t\n-2: Demand Driven,\n-1: Rental Spot,\n0: Rental On-Demand,\n1: Rental Reserved 1 month,\n3: Rental Reserved 3 month,\n6: Rental Reserved 6 month,\n12: Rental Reserved 1 year,\n24: 'Rental Reserved 2 year',\n36: 'Rental Reserved 3 year',\n60: 'Rental Reserved 5 year',\n100: Retail New,\n101: Retail Refurbished,\n102: Retail Used" }, "country": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Country", "description": "country list, the ISO country codes 2-digit string." }, "provider_source_type": { "type": "string", "title": "Provider Source Type", "description": "provider source type must be one of the values ['Hyperscaler', 'Marketplace', 'Neocloud']" } }, "type": "object", "required": [ "product_id", "start_date", "end_date", "price_type", "provider_source_type" ], "title": "FilterPriceBase" }, "app__api__gpu__market_trend__SpotPriceBase": { "properties": { "product_slug": { "type": "string", "maxLength": 50, "title": "Product Slug", "description": "product slug, ex: n-h100-pcie-80g" }, "country": { "anyOf": [ { "type": "string", "maxLength": 2 }, { "type": "null" } ], "title": "Country", "description": "the ISO country codes 2-digit string.", "default": "" } }, "type": "object", "required": [ "product_slug" ], "title": "SpotPriceBase" }, "app__api__price__forward_residual__DashboardRequest": { "properties": { "starting_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Starting Date", "description": "Inclusive start date (YYYY-MM-DD). Omit to use the endpoint's default history window." }, "ending_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Ending Date", "description": "Inclusive end date (YYYY-MM-DD). Omit to use the endpoint's default history window." }, "gpu_list": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "minItems": 1 }, { "type": "null" } ], "title": "Gpu List", "description": "GPU types, such as ['H100', 'B200']. Grade is not exposed in this API version." } }, "type": "object", "title": "DashboardRequest" }, "app__api__price__gpu_index__DashboardRequest": { "properties": { "starting_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Starting Date", "description": "The start date you want to query, format: YYYY-MM-DD, if not provided, it will be today" }, "ending_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Ending Date", "description": "The ending date you want to query, format: YYYY-MM-DD, if not provided, it will be today" } }, "type": "object", "title": "DashboardRequest" }, "app__api__price__token_index__DashboardRequest": { "properties": { "starting_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Starting Date", "description": "The start date you want to query, format: YYYY-MM-DD, if not provided, it will be today" }, "ending_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Ending Date", "description": "The ending date you want to query, format: YYYY-MM-DD, if not provided, it will be today" } }, "type": "object", "title": "DashboardRequest" }, "app__api__silicon__user__EmailBody": { "properties": { "email": { "type": "string", "format": "email", "title": "Email", "description": "email" } }, "type": "object", "required": [ "email" ], "title": "EmailBody" }, "app__utils__base__QueryBase": { "properties": { "num_per_page": { "type": "integer", "maximum": 100, "minimum": 1, "title": "Num Per Page", "description": "how many records will be return per one page, value score in 1 to 100，default value is 50", "default": 50 }, "page_num": { "type": "integer", "minimum": 1, "title": "Page Num", "description": "the page index number, default value is 1", "default": 1 }, "keyword": { "type": "string", "title": "Keyword", "description": "keyword for query conditions which use for search.", "default": "" } }, "type": "object", "title": "QueryBase" } }, "securitySchemes": { "OAuth2PasswordBearer": { "type": "oauth2", "flows": { "password": { "scopes": {}, "tokenUrl": "token" } } } } } }