跳转到内容

API

Helio-Additive 的 GraphQL API 提供了灵活性和精确定义所需数据的能力。我们提供的 SDK 利用下面列出的 API,以便快速开始;对于我们不支持的语言,可以使用下面列出的 API 文档来创建您自己的方式与我们的服务交互。

GraphQL 请求只是作为 HTTP POST 发送的常规 JSON 请求,包含两个键:queryvariables。查询是使用 GraphQL 语法定义操作和要发送/接收的变量的字符串,变量是包含要发送/接收的值的对象。下面的简单示例展示了如何使用 cURL 实现这一点。

Terminal window
curl -X POST https://api.helioadditive.com/graphql/sdk \
-H "Content-Type: application/json" \
-H "Authorization: Bearer HELIOADDITIVE_PAT" \
-d '{
"query": "query Simulation($id: ID!) { simulation(id: $id) { name status } }",
"variables": {
"id": "12345"
}
}'

查询类型定义了从服务器检索数据的 GraphQL 操作。

Retrieve a list of FAQ's.

faqs 的参数
名称 描述
page (Int) The page number to retrieve
pageSize (Int) The page size to retrieve

Retrieve a list of Events.

events 的参数
名称 描述
page (Int) Page number (1-based index)
pageSize (Int) Page size

Retrieve a list of G-Codes.

gcodes 的参数
名称 描述
page (Int) The page number to retrieve
pageSize (Int) The number of items per page
sortBy (GcodeField) Field to sort the results by
sortDirection (SortDirection) Direction to sort the results (ascending or descending).
filters ([GcodeFilter!]) List of filters to apply to the Gcode results

Retrieve details of a single G-Code by its ID.

返回: Gcode!
gcode 的参数
名称 描述
id (ID!) ID of the Gcode to retrieve

Fetch thermal history asset data.

返回: SimulationAsset
thermalHistories 的参数
名称 描述
optimizationId (ID!) (No description provided)
layer (Int!) (No description provided)
isOptimized (Boolean!) (No description provided)

Retrieve a list of materials

materials 的参数
名称 描述
page (Int) The page number to retrieve (1-based index).
pageSize (Int) The number of items per page.
sortBy (MaterialField) Field to sort the results by.
sortDirection (SortDirection) Direction to sort the results (ascending or descending).
filters ([MaterialFilter!]) List of filters to apply to the Material results.

Retrieve details of a single material by its ID.

返回: Material!
material 的参数
名称 描述
id (ID!) The unique identifier of the Material to retrieve.

Retrieve a list of material brands.

materialBrands 的参数
名称 描述
page (Int!) (No description provided)
pageSize (Int!) (No description provided)

Retrieve a summary of materials.

Retrieve login history for the user.

返回: [Login!]!

Retrieve personal access tokens for the user.

Retrieve a list of printers.

printers 的参数
名称 描述
page (Int) The page number to retrieve (1-based index).
pageSize (Int) The number of items per page.
sortBy (PrinterField) Field to sort the results by.
sortDirection (SortDirection) Direction to sort the results (ascending or descending).
filters ([PrinterFilter!]) List of filters to apply to the Printer results.

Retrieve a specific printer by its ID.

返回: Printer!
printer 的参数
名称 描述
id (ID!) The unique identifier of the Printer to retrieve.

Retrieve the default simulation parameters.

返回: NewsArticle!
newsArticle 的参数
名称 描述
id (ID!) (No description provided)

Retrieve a list of News articles.

newsArticles 的参数
名称 描述
page (Int) Page number
pageSize (Int) Page size

Feedback for a news article.

newsArticleFeedback 的参数
名称 描述
newsArticleId (ID!) (No description provided)

Retrieve a list of simulations.

simulations 的参数
名称 描述
page (Int) The page number to retrieve (1-based index).
pageSize (Int) The number of items per page.
sortBy (SimulationField) Field to sort the results by.
sortDirection (SortDirection) Direction to sort the results (ascending or descending).
filters ([SimulationFilter!]) List of filters to apply to the Simulation results.

Retrieve a list of optimizations.

optimizations 的参数
名称 描述
page (Int) The page number to retrieve (1-based index).
pageSize (Int) The number of items per page.
sortBy (SimulationField) Field to sort the results by.
sortDirection (SortDirection) Direction to sort the results (ascending or descending).
filters ([SimulationFilter!]) List of filters to apply to the Optimization results.

Retrieve the default simulation parameters.

defaultSimulationSettings 的参数
名称 描述
gcodeId (ID!) The unique identifier of the G-Code for which to get default simulation settings.
roomTemperature (Float) Ambient room temperature in Celsius.
stabilizedTemperature (Float) Stabilized air temperature in Celsius.
constantPlatformTemperature (Float) Constant platform temperature in Celsius.

Retrieve the default simulation parameters.

defaultOptimizationSettings 的参数
名称 描述
gcodeId (ID!) The unique identifier of the G-Code for which to get default optimization settings.

Retrieve the default simulation parameters.

返回: Optimization!
optimization 的参数
名称 描述
id (ID!) The unique identifier of the Optimization to retrieve.

Retrieve the default simulation parameters.

返回: Simulation!
simulation 的参数
名称 描述
id (ID!) The unique identifier of the Simulation to retrieve.

Retrieve a summary of the platform.

返回: Summary!

Generate a presigned URL for uploading a file.

返回: PresignedUrl!
getPresignedUrl 的参数
名称 描述
fileName (String!) (No description provided)

Retrieve a list of available subscriptions.

subscriptions 的参数
名称 描述
page (Int!) (No description provided)
pageSize (Int!) (No description provided)

Retrieve a list of available subscriptions.

subscriptionAddOns 的参数
名称 描述
page (Int!) (No description provided)
pageSize (Int!) (No description provided)

Retrieve transaction histories for the currently authenticated user.

transactionHistoriesForUser 的参数
名称 描述
page (Int!) (No description provided)
pageSize (Int!) (No description provided)

Retrieve the currently authenticated user.

返回: User!

变更类型定义了在服务器上更改数据的 GraphQL 操作。

Create a new G-Code.

createGcode 的参数
名称 描述
input (CreateGcodeInput!) Input object containing all fields required to create a new G-Code.

Delete an existing G-Code by its ID.

返回: Boolean!
deleteGcode 的参数
名称 描述
id (ID!) (No description provided)

Update an existing G-Code.

updateGcode 的参数
名称 描述
id (ID!) The unique identifier of the G-Code to update.
input (UpdateGcodeInput!) Input object containing fields to update for the specified G-Code.

Create a comment on a news article.

createNewsArticleComment 的参数
名称 描述
newsArticleId (ID!) (No description provided)
commentMarkdown (String!) (No description provided)

Create a new simulation based on a G-Code.

返回: Simulation!
createSimulation 的参数
名称 描述
input (CreateSimulationInput!) Input data for creating a simulation

Create a Paddle portal session for managing subscriptions.

Create a new personal access token.

createPersonalAccessToken 的参数
名称 描述
name (String!) (No description provided)
expirationDaysDelta (Int!) (No description provided)

Create a new optimization based on a G-code.

返回: Optimization!
createOptimization 的参数
名称 描述
input (CreateOptimizationInput!) Input data for creating an optimization

Create a new suggestion for the L-FAM platform.

返回: Suggestion!
createSuggestion 的参数
名称 描述
input (CreateSuggestionInput!) (No description provided)

Redeem a free trial code for the platform.

返回: FreeTrialCode!
redeemFreeTrialCode 的参数
名称 描述
input (RedeemFreeTrialCodeInput!) (No description provided)

Send an OTP to the user's email address.

sendOtp 的参数
名称 描述
email (String!) (No description provided)
proceed (Boolean!) (No description provided)

Stop a running simulation.

返回: Boolean!
stopSimulation 的参数
名称 描述
id (ID!) (No description provided)

Stop a running optimization.

返回: Boolean!
stopOptimization 的参数
名称 描述
id (ID!) (No description provided)

Verify the OTP sent to the user's email address.

verifyOtp 的参数
名称 描述
email (String!) (No description provided)
otpCode (String!) (No description provided)

Update feedback for a news article.

updateNewsArticleFeedback 的参数
名称 描述
newsArticleId (ID!) (No description provided)
input (NewsArticleFeedbackInput!) (No description provided)

订阅对于实时通知客户端后端数据的更改非常有用,例如创建新对象或更新重要字段。

AlternativeMaterialNames 的字段
名称 描述
bambustudio (String)

AlternativePrinterNames 的字段
名称 描述
bambustudio (String)

Represents a news articles comments.

Author 的字段
名称 描述
id (ID!)
name (String!) Name of the author.
position (String!) Position or title of the author.
avatarUrl (String) URL of the author's avatar image.
insertedAt (DateTime!) Timestamp when the comment was created.
updatedAt (DateTime!) Timestamp when the comment was last updated.

Represents the result of attempting to create a new G-code entry.

CreateGcodeResponse 的字段
名称 描述
gcode (Gcode) The parsed G-code object if creation was successful; otherwise, null.
errors ([GcodeError!]!) Detailed failure flags if the G-code could not be created.

Response object for creating a personal access token.

CreatePatTokenResponse 的字段
名称 描述
name (String!)
token (String!)
expiresOn (DateTime!)

An event entry with details such as date, location, and status.

Event 的字段
名称 描述
id (ID!) Unique identifier for the event.
name (String!) Name of the event.
location (String!) Location where the event takes place.
startDate (DateTime!) Start date and time of the event.
endDate (DateTime!) End date and time of the event.
link (String) Optional URL link with more details or registration for the event.
isUpcoming (Boolean!) Indicates if the event is upcoming based on current date.
insertedAt (DateTime!) Timestamp when the event was created.
updatedAt (DateTime!) Timestamp of the last update to the event.

Frequently Asked Question entry with localized question and answer content.

Faq 的字段
名称 描述
id (ID!) Unique identifier for the FAQ entry.
question (String) Localized question text shown to users.
answer (String) Localized answer text shown to users.
category (FaqCategory) Category the FAQ belongs to, such as General or Technical.
insertedAt (DateTime!) Timestamp of when the FAQ was created.
updatedAt (DateTime!) Timestamp of the last update to the FAQ.

Details of free trial codes.

FreeTrialCode 的字段
名称 描述
id (ID!) Unique identifier for the code.
code (String!) The free trial code itself.
isUsed (Boolean!) Indicates whether the free trial code has been used.
group (FreeTrialCodeGroup!) The group this code belongs to.
user (User) User who redeemed the code, if any.
insertedAt (DateTime!) Timestamp when the free trial code was created.
updatedAt (DateTime!) Timestamp when the free trial code was last updated.

Details of free trial code groups.

FreeTrialCodeGroup 的字段
名称 描述
id (ID!) Unique identifier for the code group.
subscription (HelioSubscription!) ID of the associated subscription.
company (String!) Company associated with the code group.
name (String!) Name of the code group.
expirationDate (DateTime!) Expiration date of the code group.
quantityOfCodes (Int!) Number of codes in the group.
isExpired (Boolean!) Whether the code group is expired.
insertedAt (DateTime!) Timestamp when the code group was created.
updatedAt (DateTime!) Timestamp when the code group was last updated.

Represents parsed data and metadata extracted from a G-code file.

Gcode 的字段
名称 描述
id (ID!) Unique identifier for the G-code file.
name (String!) Original name of the G-code file.
sizeKb (Float!) Size of the G-code file in kilobytes.
height (Float!) Maximum height reached during the print, in millimetres.
width (Float!) Maximum width of the print area, in millimetres.
depth (Float!) Maximum depth of the print area, in millimetres.
platformTemperature (GcodeCustomFloat) Platform (bed) temperature used during the print. May be overridden or missing.
nozzleTemperatureMin (GcodeCustomFloat!) Minimum nozzle temperature detected in the G-code.
nozzleTemperatureMax (GcodeCustomFloat!) Maximum nozzle temperature detected in the G-code.
gcodeUrl (String!) URL to the G-code file in storage, if available. May be null if not stored.
gcodeKey (String!) Key used to access the G-code file in storage. This is not a URL but a unique identifier.
roadWidthMin (GcodeCustomFloat!) Minimum road width specified in the G-code.
roadWidthMax (GcodeCustomFloat!) Maximum road width specified in the G-code.
layerHeightMin (GcodeCustomFloat!) Minimum layer height specified in the G-code.
layerHeightMax (GcodeCustomFloat!) Maximum layer height specified in the G-code.
speedMin (GcodeCustomFloat!) Minimum print speed specified in the G-code.
speedMax (GcodeCustomFloat!) Maximum print speed specified in the G-code.
fanSpeedMin (GcodeCustomFloat!) Minimum fan speed used in the G-code.
fanSpeedMax (GcodeCustomFloat!) Maximum fan speed used in the G-code.
numberOfLayers (Int!) Total number of layers found in the G-code.
slicer (Slicer!) Slicer software identified from the G-code metadata.
material (Material!) Material associated with this G-code.
printer (Printer!) Printer associated with this G-code.
flowRatio (Float) Optional flow ratio specified in the G-code, if available.
overrideGcodeParams (OverrideGcodeParams) Overrides applied to G-code parameters, if any.
isSingleShell (Boolean!) Indicates whether the print is a single-shell structure.
maxFlowRate (Float) Maximum flow rate specified in the G-code, if available. In (m^3/s)
insertedAt (DateTime!) Timestamp when the G-code was first processed or uploaded.
updatedAt (DateTime!) Timestamp of the last update to this G-code record.

Represents a float value from a G-code with its override and state metadata.

GcodeCustomFloat 的字段
名称 描述
floatType (FloatType!) Indicates the nature of the value: regular float, NaN, positive/negative infinity, etc.
isOverriden (Boolean!) True if the value was manually overridden by the user or system.
value (Float) The actual numeric value if valid; otherwise, null for NaN or infinite values.

Details of subscriptions.

HelioSubscription 的字段
名称 描述
id (ID!) Unique identifier for the user.
name (String!) Name of the subscription plan.
description (String) Description of the subscription plan.
optsPerMonth (Int!) Number of optimization runs allowed per month under this subscription.
membershipDuration (Int) Duration of the subscription in months.
paddlePriceId (String) Paddle price ID for the subscription.
price (String) Price of the subscription plan, if applicable.
features ([String!]!) List of features included in the subscription plan.
disclaimers ([String!]!) List of disclaimers or conditions associated with the subscription plan.
button (String) Button text for the subscription plan.
category (String) Category of the subscription plan.
insertedAt (DateTime!) Timestamp when the subscription was created.
updatedAt (DateTime!) Timestamp when the subscription was last updated.

LayerRange 的字段
名称 描述
fromLayer (Int!) The starting layer number for the specified range (inclusive).
toLayer (Int!) The ending layer number for the specified range (inclusive).

Represents a user's login record.

Login 的字段
名称 描述
id (ID!) Unique identifier of the login record.
user (User!) The user associated with this login record.
loginType (LoginType!) Type of login method used (e.g. username/password or Auth0).
upUsername (String) Username used for traditional login, if applicable.
upPassword (String) Password hash used for traditional login, if applicable.
auth0UserId (String) Auth0 user ID if the user logged in via Auth0.
auth0Email (String) Email associated with the Auth0 login, if applicable.

Material 的字段
名称 描述
id (ID!) Unique identifier for the material.
name (String!) Name of the material.
density (Float!) Density of the material (e.g., in g/cm^3).
alternativeNames (AlternativeMaterialNames!) Alternative names for the materials.
brand (MaterialBrand!) Brand associated with the material.
description (String) Description of the material.
conductivityY (Float) Thermal conductivity of the material (e.g., in W/(m·K)).
capacity (Float!) Heat capacity of the material (e.g., in J/(g·K)).
conductivityX (Float!) Thermal conductivity of the material (e.g., in W/(m·K)).
conductivityZ (Float) Thermal conductivity of the material (e.g., in W/(m·K)).
emissivity (Float!) Emissivity of the material, representing its ability to emit thermal radiation.
tg (Float!) Glass transition temperature, where material changes from glassy to rubbery.
minExtrusionTemp (Float) Min extrusion temp defined by filament manufacturer.
maxExtrusionTemp (Float) Max extrusion temp defined by filament manufacturer.
dryingTemp (Float) Drying temperature in °C
dryingTimeHours (Float) Drying time in hours at that temperature
bedTempMin (Float) Minimum bed temperature in °C
bedTempMax (Float) Maximum bed temperature in °C
heatedChamberRequirement (HeatedChamberRequirement) Heated chamber requirement for this material.
applicationAreas ([ApplicationArea!]!) List of application areas for this material.
insertedAt (DateTime!) Timestamp of when the material was first added.
updatedAt (DateTime!) Timestamp of the last update to the material.

MaterialBrand 的字段
名称 描述
id (ID!) Unique identifier for the material brand.
name (String!) Name of the material brand.
logoUrl (String) URL of the material brand's logo.
description (String) Description of the material brand.
emailToBuy (String) Email address used to inquire or purchase from the material brand.
insertedAt (DateTime!) Timestamp of when the material brand was first added.
updatedAt (DateTime!) Timestamp of the last update to the material brand.

MaterialsSummary 的字段
名称 描述
brands (Int!)
desktopMaterials (Int!)
lfamMaterials (Int!)
experimentalMaterials (Int!)

Represents a news article.

NewsArticle 的字段
名称 描述
id (ID!) Unique identifier for the news article.
title (String!) The headline or title of the news article.
summary (String!) A short summary or teaser of the article's content.
markdown (String!) The full article content written in Markdown format.
coverUrl (String) Optional URL to the article's cover image.
status (NewsArticleStatus!) The current publication status of the article.
tags ([NewsArticleTag!]!) List of tags categorizing the article.
comments ([NewsArticleComment!]!) List of comments made on the article.
nLikes (Int!) Number of likes the article has received.
nComments (Int!) Number of comments on the article.
author (Author!) The author of the article, if available.
insertedAt (DateTime!) Timestamp when the article was created.
updatedAt (DateTime!) Timestamp of the last article update.

Represents a news articles comments.

NewsArticleComment 的字段
名称 描述
id (ID!)
user (User) User associated with this login record.
commentMarkdown (String!) Markdown content of the comment.
insertedAt (DateTime!) Timestamp when the comment was created.
updatedAt (DateTime!) Timestamp when the comment was last updated.

Represents feedback for news articles.

NewsArticleFeedback 的字段
名称 描述
id (ID!)
user (User) User associated with this login record.
isLike (Boolean!) Indicates if the feedback is a like (True) or dislike (False).
isNotImportant (Boolean!) Indicates if the feedback is marked as not important.
isNiceToHave (Boolean!) Indicates if the feedback is marked as nice to have.
isImportant (Boolean!) Indicates if the feedback is marked as important.
isCritical (Boolean!) Indicates if the feedback is marked as critical.
insertedAt (DateTime!) Timestamp when the comment was created.
updatedAt (DateTime!) Timestamp when the comment was last updated.

Represents an optimization simulation with detailed configuration and results.

Optimization 的字段
名称 描述
id (ID!) Unique identifier for the optimization simulation.
spec (Int!) Specification version or type used in the simulation.
name (String!) Name of the optimization simulation.
index (Int!) Index or sequence number of the simulation.
isOptimization (Boolean!) Indicates if this is an optimization simulation.
progress (Float!) Progress percentage of the simulation (between 0 and 100)
status (SimulationStatus!) Current status or state of the simulation.
originalPreviewImageUrl (String) URL for the original simulation preview image.
optimizedPreviewImageUrl (String) URL for the optimized simulation preview image.
originalReportJsonUrl (String) Presigned URL for the original simulation report.
optimizedReportJsonUrl (String) Presigned URL for the optimized simulation report.
optimizedGcodeUrl (String) Presigned URL for the optimized G-code.
optimizedGcodeWithThermalIndexesUrl (String) Presigned URL for the optimized G-code annotated with thermal indexes.
extrusionPathsAsset (SimulationAsset) Parquet asset with extrusion path data.
originalMeshAsset (SimulationAsset) Parquet asset of the original public mesh.
contactsAsset (SimulationAsset) Parquet asset with contact data.
originalCoordinateAsset (SimulationAsset) Parquet asset with original coordinates.
optimizedMeshAsset (SimulationAsset) Parquet asset of the optimized public mesh.
simulationSettings (SimulationSettings!) Settings used for the simulation, including overrides for temperatures and fan speeds.
optimizationSettings (OptimizationSettings!) Settings specific to the optimization run, including variable overrides and constraints.
optimizationReductionStrategySettings (OptimizationReductionStrategySettings!) Settings for the reduction strategy used in the optimization run.
optimizationResidualStrategySettings (OptimizationResidualStrategySettings!) Settings for the residual strategy used in the optimization run.
gcode (Gcode!) G-code file associated with the optimization run.
printer (Printer!) Printer model used in the simulation.
material (Material!) Material used for the simulation.
optimizedThermalIndexStatistics (OptimizedThermalIndexStatistics!) Statistics related to thermal indices in the optimization run.
originalThermalIndexStatistics (ThermalIndexStatistics!) Statistics related to thermal indices in the original run.
optimizeOuterwall (Boolean!) Whether to optimize the outer wall of the print.
insertedAt (DateTime!) Timestamp when the simulation was created.
updatedAt (DateTime!) Timestamp when the simulation was last updated.

OptimizationReductionStrategySettings 的字段
名称 描述
optimizationReductionStrategy (OptimizationReductionStrategy) Reduction strategy used in the optimization run.
optimizationReductionAutolinearDoCriticality (Boolean) Whether to apply autolinear criticality reduction.
optimizationReductionAutolinearDoFitness (Boolean) Whether to apply autolinear fitness-based reduction.
optimizationReductionAutolinearDoInterpolation (Boolean) Whether to apply interpolation in autolinear reduction.
optimizationReductionAutolinearCriticalityMaxNodesDensity (Float) Max node density for autolinear criticality.
optimizationReductionAutolinearCriticalityThreshold (Float) Threshold value for autolinear criticality.
optimizationReductionAutolinearFitnessMaxNodesDensity (Float) Max node density for autolinear fitness.
optimizationReductionAutolinearFitnessThreshold (Float) Threshold value for autolinear fitness.
optimizationReductionAutolinearInterpolationLevels (Int) Number of interpolation levels in autolinear reduction.
optimizationReductionLinearNodesLimit (Int) Limit on number of nodes in linear reduction strategy.

OptimizationResidualStrategySettings 的字段
名称 描述
optimizationResidualStrategy (OptimizationResidualStrategy) Residual Strategy used in the optimization run.
optimizationResidualExponentialPenaltyLow (Float) Low value of exponential penalty applied to residuals.
optimizationResidualExponentialPenaltyHigh (Float) High value of exponential penalty applied to residuals.

OptimizationSettings 的字段
名称 描述
minVelocity (Float!) Minimum velocity used during optimization.
maxVelocity (Float!) Maximum velocity allowed during optimization.
minVelocityIncrement (Float!) Minimum velocity increment allowed.
minExtruderFlowRate (Float!) Maximum extruder flow rate during optimization.
maxExtruderFlowRate (Float!) Minimum extruder flow rate during optimization.
tolerance (Float!) Tolerance value for convergence in optimization.
maxIterations (Int!) Maximum number of iterations in the optimization run.
nNodes (Int!) Number of nodes used in the optimization process.
reductionStrategySettings (ReductionStrategySettings!) Configuration settings for the reduction strategy used during optimization.
residualStrategySettings (ResidualStrategySettings!) Configuration settings for the residual strategy used during optimization.
layersToOptimize ([LayerRange!]!) List of layer ranges to include in the optimization process.
optimizer (Optimizer!) Selected optimization algorithm to use during the simulation process.
optimizeOuterwall (Boolean!) Whether to optimize the outer wall of the print.

OptimizedThermalIndexStatistics 的字段
名称 描述
optimizedThermalIndexCount (Int) Number of thermal index data points in the optimized simulation.
optimizedThermalIndexMean (Float) Mean value of the optimized thermal index.
optimizedThermalIndexStd (Float) Standard deviation of the optimized thermal index.
optimizedThermalIndexMin (Float) Minimum value of the optimized thermal index.
optimizedThermalIndex25 (Float) 25th percentile of the optimized thermal index.
optimizedThermalIndex50 (Float) 50th percentile (median) of the optimized thermal index.
optimizedThermalIndex75 (Float) 75th percentile of the optimized thermal index.
optimizedThermalIndexMax (Float) Maximum value of the optimized thermal index.

Override values for key G-code parameters used during simulation or optimization.

OverrideGcodeParams 的字段
名称 描述
overrideConstantNozzleTemperature (Float) Constant nozzle temperature override in Kelvin.
overrideConstantLayerHeight (Float) Constant layer height override in mm, if specified.
overrideConstantRoadWidth (Float) Constant road width override in mm, if specified.
overrideConstantPlatformTemperature (Float) Constant platform temperature override in Kelvin, if specified.

PaddlePortalSessionResponse 的字段
名称 描述
url (String)
error (String)

Metadata about the pagination state.

PageInfo 的字段
名称 描述
hasPreviousPage (Boolean!) Indicates if there is a previous page.
hasNextPage (Boolean!) Indicates if there is a next page.

Paginated list of objects

PaginatedResponse 的字段
名称 描述
pages (Int!) Number of total pages available for the current query.
pageInfo (PageInfo!) Information about pagination.
objects ([MaterialPrinterSimulationOptimizationEventGcodeFaqNewsArticleMaterialBrandTransactionHistoryHelioSubscriptionSubscriptionAddOn!]!) List of objects on the current page.

Represents a personal access token for user authentication.

PersonalAccessToken 的字段
名称 描述
name (String!) Name or identifier for the personal access token.
expiresOn (DateTime!) Expiration date and time of the personal access token.

Contains information for uploading a file using a presigned URL.

PresignedUrl 的字段
名称 描述
mimeType (String!) MIME type of the file associated with the presigned URL.
url (String!) Presigned URL allowing for direct uploads.
key (String!) Key or identifier associated with the file in storage.

Printer 的字段
名称 描述
id (ID!) Unique identifier for the printer.
name (String!) Name of the printer.
alternativeNames (AlternativePrinterNames!) Alternative names for the printers.
brand (PrinterBrand!) Brand associated with the printer.
nozzleDiameter (Float!) Diameter of the printer's nozzle.
heatedBed (Boolean!) Indicates if the printer has a heated bed.
heatedChamber (Boolean!) Indicates if the printer has a heated chamber.
maxExtruderFlowRate (Float!) Maximum extruder flow rate.
minExtruderFlowRate (Float!) Minimum extruder flow rate.
maxHardwareExtrusionTemp (Float!) Maximum temperature the printer's hardware can achieve during extrusion.
minHardwareExtrusionTemp (Float!) Minimum temperature the printer's hardware operates at during extrusion.
minHardwarePrintSpeed (Float!) Minimum print speed the printer can handle, in mm/s.
maxHardwarePrintSpeed (Float!) Maximum print speed the printer can handle, in mm/s.
chamberType (ChamberType!) Type of the printer's chamber, e.g., no chamber, heated or unheated.
nNodes (Int!) Number of nodes in the printer's model.
insertedAt (DateTime!) Timestamp when the printer was created.
updatedAt (DateTime!) Timestamp of the last update.

PrinterBrand 的字段
名称 描述
id (ID!) Unique identifier for the printer brand.
name (String!) Name of the printer brand.
logoUrl (String) URL to the brand's logo, if available.
description (String) Detailed description of the brand, if provided.
insertedAt (DateTime!) Timestamp of when the brand was added.
updatedAt (DateTime!) Timestamp of the last update to the brand.

ReductionStrategySettings 的字段
名称 描述
strategy (OptimizationReductionStrategy!) The strategy used to reduce the number of nodes in the optimization process.
autolinearDoCriticality (Boolean!) Enable automatic linear reduction based on thermal criticality.
autolinearDoFitness (Boolean!) Enable automatic linear reduction based on fitness values.
autolinearDoInterpolation (Boolean!) Enable interpolation during automatic linear reduction.
autolinearCriticalityMaxNodesDensity (Float!) Maximum nodes density for criticality-based auto-linear reduction.
autolinearCriticalityThreshold (Float!) Thermal index threshold for triggering criticality-based reduction.
autolinearFitnessMaxNodesDensity (Float!) Maximum nodes density for fitness-based auto-linear reduction.
autolinearFitnessThreshold (Float!) Fitness threshold for triggering fitness-based reduction.
autolinearInterpolationLevels (Int!) Number of interpolation levels to apply in auto-linear strategy.
linearNodesLimit (Int!) Maximum number of nodes allowed for the linear reduction strategy.

ResidualStrategySettings 的字段
名称 描述
strategy (OptimizationResidualStrategy!) The residual strategy used for optimization, such as linear or exponential.
exponentialPenaltyHigh (Float!) Penalty applied to residuals above the target range when using exponential strategy.
exponentialPenaltyLow (Float!) Penalty applied to residuals below the target range when using exponential strategy.

SendOtpResponse 的字段
名称 描述
success (Boolean!)
messageId (String)
error (String)

Represents a simulation run with associated metadata and results.

Simulation 的字段
名称 描述
id (ID!) Unique identifier for the simulation.
name (String!) Name or title of the simulation.
progress (Float!) Progress percentage of the simulation (between 0 and 100)
status (SimulationStatus!) Current status or phase of the simulation.
meshUrl (SimulationAsset) Public-facing original mesh asset (Parquet).
gcode (Gcode!) G-code used to run the simulation.
printer (Printer!) Printer used for the simulation.
material (Material!) Material used for the simulation.
reportJsonUrl (String) Presigned URL for downloading the original simulation report.
thermalIndexGcodeUrl (String) Presigned URL to download thermal index G-code.
estimatedSimulationDurationSeconds (Float) Estimated duration of the simulation in seconds.
simulationSettings (SimulationSettings!)
thermalIndexStatistics (ThermalIndexStatistics!) Statistics related to thermal indices in the simulation.
updatedAt (DateTime!) Timestamp when the simulation was last updated.
insertedAt (DateTime!) Timestamp when the simulation was created.

SimulationAsset 的字段
名称 描述
assetType (SimulationAssetType!)
url (String!)

SimulationSettings 的字段
名称 描述
airTemperatureAboveBuildPlate (Float!) Ambient air temperature just above the build plate, in degrees Kelvin.
temperatureStabilizationHeight (Float!) Height at which temperature stabilization occurs, in millimeters.
stabilizedAirTemperature (Float!) The temperature maintained at the stabilization height, in degrees Kelvin.
constantPlatformTemperature (Float) Optional override for the platform (bed) temperature, in degrees Kelvin.
constantNozzleTemperature (Float) Optional override for the nozzle temperature, in degrees Kelvin.
constantFanSpeed (Float) Optional override for fan speed as a percentage (0–100).

Details of subscription add on.

SubscriptionAddOn 的字段
名称 描述
id (ID!) Unique identifier for the code group.
subscriptions ([HelioSubscription!]!) List of associated subscriptions.
name (String!) Name of the code group.
description (String) Description of add on
addOnOptimizationsCount (Int!) Amount of extra optimizations
addOnPriceId (String!) Price id from paddle
price (String) Price of the subscription add-on, if applicable.
features ([String!]!) List of features included in the subscription add-on.
disclaimers ([String!]!) List of disclaimers or conditions associated with the subscription add-on.
button (String) Button text for the subscription add-on.
category (String) Category of the subscription plan.
insertedAt (DateTime!) Timestamp when the add-on group was created.
updatedAt (DateTime!) Timestamp when the add-on group was last updated.

Represents a suggestion for the Lfam dashboard.

Suggestion 的字段
名称 描述
id (ID!)
user (User)
content (String!)
insertedAt (DateTime!)
updatedAt (DateTime!)

Summary 的字段
名称 描述
simulationCount (Int!)
materialCount (Int!)
printerCount (Int!)

ThermalIndexStatistics 的字段
名称 描述
thermalIndexCount (Int) Number of thermal index values in the original simulation.
thermalIndexMean (Float) Mean of the thermal index values in the original simulation.
thermalIndexStd (Float) Standard deviation of the original thermal index values.
thermalIndexMin (Float) Minimum thermal index value observed.
thermalIndex25 (Float) 25th percentile of thermal index values.
thermalIndex50 (Float) Median or 50th percentile of thermal index values.
thermalIndex75 (Float) 75th percentile of thermal index values.
thermalIndexMax (Float) Maximum thermal index value observed.

Represents a record of a user's subscription transaction.

TransactionHistory 的字段
名称 描述
id (ID!) Unique identifier of the transaction record.
user (User!) The user associated with this transaction.
name (String!) Name of the subscription or transaction item.
description (String) Optional description of the transaction.
optsPerMonth (Int) Number of optimizations allowed per month in this transaction.
subscription (HelioSubscription) Subscription associated with this transaction, if applicable.
addOn (SubscriptionAddOn) Add-on associated with this transaction, if applicable.
addOnOptimizations (Int) Number of bonus optimizations granted by the add-on, if applicable.
subscriptionStartDate (DateTime) Start date of the subscription associated with this transaction.
subscriptionEndDate (DateTime) End date of the subscription associated with this transaction.
paddleBillingStatus (String) Status of current transaction
insertedAt (DateTime!) Timestamp when the transaction record was created.
updatedAt (DateTime!) Timestamp when the transaction record was last updated.

Represents the result of attempting to update an uploaded G-code.

UpdateGcodeResponse 的字段
名称 描述
gcode (Gcode) The parsed G-code object if the file was successfully processed; otherwise, null.
errors ([GcodeError!]!) Detailed failure flags if the G-code update encountered issues during parsing.

Details of a user in the system.

User 的字段
名称 描述
id (ID!) Unique identifier of the user.
email (String) User's email address.
handle (String) Custom user handle or username.
type (UserType!) The user type or role in the system (e.g. Hobbyist, Academic).
avatarUrl (String) URL to the user's avatar image.
transactionHistories ([TransactionHistory!]!) List of the user's transaction history records.
remainingOptsThisMonth (Int) Remaining number of optimizations allowed for the user this month.
subscriptionStartDate (DateTime) Start date of the user's subscription, if active.
subscriptionEndDate (DateTime) End date of the user's subscription, if active.
subscription (HelioSubscription) Subscription details for the user, if any.
paddleBillingPeriodStart (DateTime) Start date of the Paddle billing period.
paddleBillingPeriodEnd (DateTime) End date of the Paddle billing period.
paddleNextBilledAt (DateTime) Next billing date for the Paddle subscription, if applicable.
paddleBillingCycleInterval (String) Interval for Paddle billing cycles (e.g., monthly, yearly).
paddleBillingCycleFrequency (Int) Frequency of Paddle billing cycles (e.g., 1 for monthly, 12 for yearly).
paddleBillingStatus (String) Status of current transaction
addOnOptimizations (Int) Bonus optimizations
logins ([Login!]!) List of user login records.
paddleCustomerId (String) Paddle customer ID associated with the subscription.
lastOtpRequestedAt (DateTime) Timestamp of the last OTP request for this user.
membershipStatus (String!) Indicates if the user has an active subscription.

VerifyOtpResponse 的字段
名称 描述
success (Boolean!)
error (String)

BooleanFilter 的字段
名称 描述
equalTo (Boolean)
notEqualTo (Boolean)

CreateGcodeInput 的字段
名称 描述
name (String!) The name of the gcode.
materialId (ID!) The ID of the material.
printerId (ID!) The ID of the printer.
gcodeKey (String!) The key of the gcode.
nozzleTemperature (Float) The nozzle temperature.
isSingleShell (Boolean!) Whether the gcode is single shell.
layerHeight (Float) The layer height.
lineWidth (Float) The line width.
platformTemperature (Float) The platform temperature.

CreateOptimizationInput 的字段
名称 描述
name (String!) User-defined name for the optimization run.
gcodeId (ID!) Unique identifier of the G-code to optimize.
simulationSettings (SimulationSettingsInput) Settings related to the simulation environment and initial conditions.
optimizationSettings (OptimizationSettingsInput) Parameters and strategy configurations for running the optimization.

CreateSimulationInput 的字段
名称 描述
name (String!) User-defined name for the simulation.
gcodeId (ID!) Unique identifier of the G-code to simulate.
simulationSettings (SimulationSettingsInput) Settings related to the simulation environment and parameters.

CreateSuggestionInput 的字段
名称 描述
content (String) Suggestion.

Filter 的字段
名称 描述
stringFilter (StringFilter)
floatFilter (FloatFilter)
intFilter (IntFilter)
booleanFilter (BooleanFilter)
statusFilter (SimulationStatusFilter) This filter is only used for filtering the status of a simulation.

FloatFilter 的字段
名称 描述
equalTo (Float)
notEqualTo (Float)
greaterThan (Float)
greaterThanOrEqualTo (Float)
lessThan (Float)
lessThanOrEqualTo (Float)
inList ([Float!]!)
notInList ([Float!]!)

GcodeFilter 的字段
名称 描述
field (GcodeField!) The field to filter on, e.g., 'name', 'status'.
filter (Filter!) The value or condition to filter the field by, e.g., 'active', 'completed'.

IntFilter 的字段
名称 描述
equalTo (Int)
notEqualTo (Int)
greaterThan (Int)
greaterThanOrEqualTo (Int)
lessThan (Int)
lessThanOrEqualTo (Int)
inList ([Int!]!)
notInList ([Int!]!)

LayerRangeInput 的字段
名称 描述
fromLayer (Int!) The starting layer number for the specified range (inclusive).
toLayer (Int!) The ending layer number for the specified range (inclusive).

MaterialFilter 的字段
名称 描述
field (MaterialField!) The field to filter on, e.g., 'name', 'status'.
filter (Filter!) The value or condition to filter the field by, e.g., 'active', 'completed'.

NewsArticleFeedbackInput 的字段
名称 描述
isLike (Boolean) Indicates if the user liked the article. If None, it means no feedback was given.
isNotImportant (Boolean) Indicates if the user found the article not important. If None, it means no feedback was given.
isNiceToHave (Boolean) Indicates if the user found the article nice to have. If None, it means no feedback was given.
isImportant (Boolean) Indicates if the user found the article important. If None, it means no feedback was given.
isCritical (Boolean) Indicates if the user found the article critical. If None, it means no feedback was given.

OptimizationSettingsInput 的字段
名称 描述
minVelocity (Float) Minimum print head velocity during optimization, in mm/s.
maxVelocity (Float) Maximum print head velocity during optimization, in mm/s.
minVelocityIncrement (Float) Minimum step size to increment velocity values during optimization, in mm/s.
minExtruderFlowRate (Float) Minimum allowed extruder flow rate during optimization, in mm³/s.
maxExtruderFlowRate (Float) Maximum allowed extruder flow rate during optimization, in mm³/s.
tolerance (Float) Tolerance threshold for optimization convergence.
maxIterations (Int) Maximum number of iterations allowed during optimization.
reductionStrategySettings (ReductionStrategySettingsInput) Configuration settings for the reduction strategy used during optimization.
residualStrategySettings (ResidualStrategySettingsInput) Configuration settings for the residual strategy used during optimization.
layersToOptimize ([LayerRangeInput!]!) List of layer ranges to include in the optimization process.
optimizer (Optimizer) Selected optimization algorithm to use during the simulation process.
optimizeOuterwall (Boolean) Flag to indicate whether to optimize the outer wall of the print.

PrinterFilter 的字段
名称 描述
field (PrinterField!) The field to filter on, e.g., 'name', 'status'.
filter (Filter!) The value or condition to filter the field by, e.g., 'active', 'completed'.

RedeemFreeTrialCodeInput 的字段
名称 描述
code (String!) Free trial code to redeem.

ReductionStrategySettingsInput 的字段
名称 描述
strategy (OptimizationReductionStrategy) The strategy used to reduce the number of nodes in the optimization process.
autolinearDoCriticality (Boolean) Enable automatic linear reduction based on thermal criticality.
autolinearDoFitness (Boolean) Enable automatic linear reduction based on fitness values.
autolinearDoInterpolation (Boolean) Enable interpolation during automatic linear reduction.
autolinearCriticalityMaxNodesDensity (Float) Maximum nodes density for criticality-based auto-linear reduction.
autolinearCriticalityThreshold (Float) Thermal index threshold for triggering criticality-based reduction.
autolinearFitnessMaxNodesDensity (Float) Maximum nodes density for fitness-based auto-linear reduction.
autolinearFitnessThreshold (Float) Fitness threshold for triggering fitness-based reduction.
autolinearInterpolationLevels (Int) Number of interpolation levels to apply in auto-linear strategy.
linearNodesLimit (Int) Maximum number of nodes allowed for the linear reduction strategy.

ResidualStrategySettingsInput 的字段
名称 描述
strategy (OptimizationResidualStrategy) The residual strategy used for optimization, such as linear or exponential.
exponentialPenaltyHigh (Float) Penalty applied to residuals above the target range when using exponential strategy.
exponentialPenaltyLow (Float) Penalty applied to residuals below the target range when using exponential strategy.

SimulationFilter 的字段
名称 描述
field (SimulationField!) The field to filter on, e.g., 'name', 'status'.
filter (Filter!) The value or condition to filter the field by, e.g., 'active', 'completed'.

SimulationSettingsInput 的字段
名称 描述
roomTemperature (Float) Ambient air temperature in the room, in degrees Kelvin
airTemperatureAboveBuildPlate (Float) Ambient air temperature just above the build plate, in degrees Kelvin.
temperatureStabilizationHeight (Float) The height at which the air temperature around the print begins to stabilize.
stabilizedAirTemperature (Float) The temperature maintained at the stabilization height, in degrees Kelvin.
constantPlatformTemperature (Float) Optional override for the platform (bed) temperature, in degrees Kelvin.
constantNozzleTemperature (Float) Optional override for the nozzle temperature, in degrees Kelvin.
constantFanSpeed (Float) Optional override for fan speed as a percentage (0–100).

SimulationStatusFilter 的字段
名称 描述
equalTo (SimulationStatus)
notEqualTo (SimulationStatus)

StringFilter 的字段
名称 描述
equalTo (String)
notEqualTo (String)
caseSensitiveContains (String)
caseInsensitiveContains (String)
caseSensitiveStartsWith (String)
caseInsensitiveStartsWith (String)
caseSensitiveEndsWith (String)
caseInsensitiveEndsWith (String)
notCaseSensitiveContains (String)
notCaseInsensitiveContains (String)
notCaseSensitiveStartsWith (String)
notCaseInsensitiveStartsWith (String)
notCaseSensitiveEndsWith (String)
notCaseInsensitiveEndsWith (String)

UpdateGcodeInput 的字段
名称 描述
name (String!) The name of the gcode.
materialId (ID!) The ID of the material.
printerId (ID!) The ID of the printer.
nozzleTemperature (Float) The nozzle temperature.
isSingleShell (Boolean!) Whether the gcode is single shell.
layerHeight (Float) The layer height.
lineWidth (Float) The line width.
platformTemperature (Float) The platform temperature.

ApplicationArea 的值
名称 描述
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]

ChamberType 的值
名称 描述
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]

Category that classifies the type of FAQ.

FaqCategory 的值
名称 描述
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]

FloatType 的值
名称 描述
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]

GcodeError 的值
名称 描述
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]

GcodeField 的值
名称 描述
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]

HeatedChamberRequirement 的值
名称 描述
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]

LoginType 的值
名称 描述
[object Object] [object Object]
[object Object] [object Object]

MaterialField 的值
名称 描述
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]

Status of a news article.

NewsArticleStatus 的值
名称 描述
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]

Tags associated with a news article.

NewsArticleTag 的值
名称 描述
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]

OptimizationReductionStrategy 的值
名称 描述
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]

OptimizationResidualStrategy 的值
名称 描述
[object Object] [object Object]
[object Object] [object Object]

Optimizer 的值
名称 描述
[object Object] [object Object]
[object Object] [object Object]

PrinterField 的值
名称 描述
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]

Defines the type or format of a simulation asset.

SimulationAssetType 的值
名称 描述
[object Object] [object Object]
[object Object] [object Object]

Defines the simulation fields

SimulationField 的值
名称 描述
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]

Represents the current lifecycle status of a simulation.

SimulationStatus 的值
名称 描述
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]

Slicer 的值
名称 描述
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]

sort direction for paginated queries.

SortDirection 的值
名称 描述
[object Object] [object Object]
[object Object] [object Object]

UserType 的值
名称 描述
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]
[object Object] [object Object]