Explore
Geometry Backend API v2 - version 2.20.0
1.8.0
OAS 3.0
The ShapeDiver Geometry Backend system is used to:
host Grasshopper models in a secure, reliable, scalable, and performant way,
run computations of Grasshopper models,
and cache and output the results of computations and exports.
ShapeDiver Help Center
Authorize
analytics
PUT
/api
/v2
/analytics
/session
/model
Get model session analytics.
PUT
/api
/v2
/analytics
/credit-metrics
Get credit metrics.
GET
/api
/v2
/analytics
/credit-metrics
/timestamp
/{timestamp}
/user
Get credit metrics of all users active at timestamp.
GET
/api
/v2
/analytics
/credit-metrics
/timestamp
/{timestamp}
/org
Get credit metrics of all organizations with users active at timestamp.
GET
/api
/v2
/analytics
/credit-metrics
/timestamp
/{timestamp}
/user
/{userId}
Get model credit metrics of the user at timestamp.
GET
/api
/v2
/analytics
/credit-metrics
/timestamp
/{timestamp}
/org
/{orgId}
Get model credit metrics of the organization at timestamp.
ar-scene
HEAD
/api
/v2
/ar-scene
/{sceneId}
Verifies whether an AR scene exists or if a Model-State is linked to an AR scene.
GET
/api
/v2
/ar-scene
/{sceneId}
/gltf
Downloads the glTF asset of an AR scene or a Model-State that is linked to an AR scene.
GET
/api
/v2
/ar-scene
/{sceneId}
/usdz
Downloads the USDZ asset of an AR scene or a Model-State that is linked to an AR scene.
assets
GET
/api
/v2
/session
/{sessionId}
/export
/{assetDataEncrypted}
Download a single export.
GET
/api
/v2
/session
/{sessionId}
/output
/{assetDataEncrypted}
Download a single output.
GET
/api
/v2
/session
/{sessionId}
/texture
/{assetDataEncrypted}
Download a single texture.
GET
/api
/v2
/session
/{sessionId}
/gltf
/{assetDataEncrypted}
Download a glTF file.
GET
/api
/v2
/session
/{sessionId}
/usdz
/{assetDataEncrypted}
Download a USDZ file.
GET
/api
/v2
/session
/{sessionId}
/image
Download an image.
GET
/api
/v2
/download
/{assetDataEncrypted}
Download an asset without a session (can be used via an URL in an email).
auth
GET
/.well-known
/jwks.json
Get the public keys of the JSON Web Key Set.
auth-group
POST
/api
/v2
/auth_group
Create new authorization group.
export
https://help.shapediver.com/doc/exports-on-the-api
PUT
/api
/v2
/session
/{sessionId}
/export
Compute a Grasshopper exports for given parameter values.
PUT
/api
/v2
/session
/{sessionId}
/export
/cache
Get Export from cache / check if computation is done.
PATCH
/api
/v2
/model
/{modelId}
/export
Update definition of exports.
GET
/api
/v2
/session
/{sessionId}
/export
/{exportId}
/list
List export versions.
file
GET
/api
/v2
/session
/{sessionId}
/file
/{paramId}
/list
List all file-assets of a parameter.
HEAD
/api
/v2
/session
/{sessionId}
/file
/{paramId}
/{fileId}
Get information about a file-asset of a parameter.
GET
/api
/v2
/session
/{sessionId}
/file
/{paramId}
/{fileId}
Download a file-asset.
DELETE
/api
/v2
/session
/{sessionId}
/file
/{paramId}
/{fileId}
Delete a file-asset.
POST
/api
/v2
/session
/{sessionId}
/file
/upload
Request upload URL for a file-asset.
gltf
POST
/api
/v2
/session
/{sessionId}
/gltf
Upload and optionally convert a glTF object.
log
POST
/api
/v2
/session
/{sessionId}
/log
/message
Log message.
model
GET
/api
/v2
/model
/{modelId}
/config
Get model config.
POST
/api
/v2
/model
/{modelId}
/config
Create model config.
PATCH
/api
/v2
/model
/{modelId}
/config
Update model config.
GET
/api
/v2
/model
/list
List models.
GET
/api
/v2
/model
/{modelId}
Get model.
PUT
/api
/v2
/model
/{modelId}
Update model.
DELETE
/api
/v2
/model
/{modelId}
Delete model.
POST
/api
/v2
/model
Create model.
PUT
/api
/v2
/model
/{modelId}
/restore
Restore a soft-deleted model.
GET
/api
/v2
/model
/{modelId}
/file
/download
Download Grasshopper file.
GET
/api
/v2
/model
/{modelId}
/computations
Get model computation statistics.
POST
/api
/v2
/model
/{modelId}
/cleanup
/export
Delete old export components.
POST
/api
/v2
/model
/{modelId}
/cleanup
/output
Delete old output components.
POST
/api
/v2
/model
/{modelId}
/cleanup
/texture
Delete old texture components.
GET
/api
/v2
/model
/{modelId}
/cleanup
/status
Get the status of all running model cleanup processes.
PATCH
/api
/v2
/model
/{modelId}
/parameter
/defval
Update default value of parameters.
PATCH
/api
/v2
/model
/{modelId}
/parameter
Update definition of parameters.
model-state
HEAD
/api
/v2
/model-state
/{modelStateId}
Checks the existence of a Model-State.
GET
/api
/v2
/model-state
/{modelStateId}
Get a Model-State.
DELETE
/api
/v2
/model-state
/{modelStateId}
Delete a Model-State.
GET
/api
/v2
/model-state
/{modelStateId}
/data
Get a Model-State's parameter and additional data.
HEAD
/api
/v2
/model-state
/{modelStateId}
/image
Checks if the Model-State has an image.
GET
/api
/v2
/model-state
/{modelStateId}
/image
Downloads the Model-State image.
GET
/api
/v2
/model-state
/model
/{modelId}
/list
List Model-States of a ShapeDiver model.
POST
/api
/v2
/session
/{sessionId}
/model-state
Create new Model-State.
output
https://help.shapediver.com/doc/outputs-on-the-api
PUT
/api
/v2
/session
/{sessionId}
/output
Compute all outputs for given parameter values.
PUT
/api
/v2
/session
/{sessionId}
/output
/cache
Get output from cache / check if computation is done.
PATCH
/api
/v2
/model
/{modelId}
/output
Update definition of outputs.
GET
/api
/v2
/session
/{sessionId}
/output
/{outputId}
/list
List output versions.
script
GET
/api
/v2
/script
/{scriptId}
/confirm
Confirm script.
GET
/api
/v2
/script
/{scriptId}
/deny
Deny script.
sdtf
https://help.shapediver.com/doc/sdtf-structured-data-transfer-format
GET
/api
/v2
/session
/{sessionId}
/sdtf
/{namespace}
/list
List all sdTF-assets of a namespace.
GET
/api
/v2
/session
/{sessionId}
/sdtf
/{namespace}
/{sdtfId}
Download a sdTF-asset.
DELETE
/api
/v2
/session
/{sessionId}
/sdtf
/{namespace}
/{sdtfId}
Delete a sdTF-assets.
POST
/api
/v2
/session
/{sessionId}
/sdtf
/upload
Request upload URL for a sdTF-asset.
session
https://help.shapediver.com/doc/sessions-and-their-lifetime
POST
/api
/v2
/model
/{modelId}
/session
Initialize new session by model ID.
POST
/api
/v2
/ticket
/{ticketId}
Initialize new session by ticket.
GET
/api
/v2
/session
/{sessionId}
/default
Get session defaults (corresponds to the content of the session initialization request).
POST
/api
/v2
/session
/{sessionId}
/close
Close session.
POST
/api
/v2
/model
/{modelId}
/ticket
Create a new ticket that allows to initialize a new session.
GET
/api
/v2
/ticket
/{ticketEncrypted}
Decrypt the given ticket and return its details.
system
DELETE
/api
/v2
/system
/model
/{modelId}
Delete model permanently.
GET
/api
/v2
/system
/minions
/info
Get system information about the Geometry Minions.
GET
/api
/v2
/system
/workers
/info
Get system information about the Geometry Workers.
GET
/api
/v2
/system
/sign
/cdn
/{endpoint}
/{encodedUri}
Create a signed URL for the specified endpoint and target.
texture
GET
/api
/v2
/session
/{sessionId}
/texture
/list
List model textures.
Schemas
AnyDateTime
AnyDateExtended
Base64Data
FullDate
DateHour
DateHourMinute
DateTime
DateTimeMs
DateTimeIso
Epoch
EpochMs
NullObj
OctetStream
Uuid
Year
YearMonth
AnyValue
CommonsComputationStatus
CommonsGroup
CommonsModelBlockingReasons
CommonsModelStatus
CommonsBasicParameter
CommonsStypeParameter
CommonsTicket
CommonsTicketType
QueryComputationStatisticsStatus
QueryComputationStatus
QueryComputationType
QueryGltfConversion
QueryModelStatus
QueryOrder
ReqGroup
ReqTicket
ReqTicketType
ReqConfigure
ReqLogLevel
ReqLogMessage
ReqAuthorizationGroup
ReqModelStatistics
ReqAnyCreditMetricId
ReqCreditMetrics
ReqBasicParameter
ReqStypeParameter
ReqParameterValue
ReqCustomization
ReqExport
ReqExportDefinitions
ReqExportDefinition
ReqOutputDefinitions
ReqOutputDefinition
ReqCache
ReqExportOrCache
ReqCustomizationOrCache
ReqCustomizationOrExport
ReqModelState
ReqModelFileType
ReqTrustLevel
ReqModel
ReqParameterDefinitions
ReqParameterDefinition
ReqFileUpload
ReqFileDefinition
ReqSdtfDefinition
ReqSdtfType
ResBase
ResBaseAsset
ResBaseList
ResBaseModelState
ResBaseSystem
ResGetModelStatistics
ResGetCreditMetrics
ResGetUserCreditMetrics
ResGetOrganizationCreditMetrics
ResGetModelUserCreditMetrics
ResGetModelOrganizationCreditMetrics
ResCreateAuthorizationGroup
ResComputeExports
ResGetCachedExports
ResUpdateExportDefinitions
ResListExportVersions
ResListFiles
ResDeleteFile
ResUploadFile
ResUploadGltf
ResLogMessage
ResGetModelConfig
ResCreateModelConfig
ResUpdateModelConfig
ResListModels
ResGetModel
ResUpdateModel
ResDeleteModel
ResCreateModel
ResGetModelComputations
ResGetModelState
ResGetModelStateData
ResCreateModelState
ResListModelStates
ResDeleteModelState
ResCleanupExports
ResCleanupOutputs
ResCleanupTextures
ResGetCleanupStatus
ResUpdateParameterDefaultValues
ResUpdateParameterDefinitions
ResComputeOutputs
ResGetCachedOutputs
ResUpdateOutputDefinitions
ResListOutputVersions
ResListSdtfs
ResDeleteSdtf
ResUploadSdtf
ResCreateSessionByModel
ResCreateSessionByTicket
ResGetSessionDefaults
ResCloseSession
ResCreateTicket
ResDecryptTicket
ResGetMinionsInfo
ResGetWorkersInfo
ResListTextures
ResPartVersion
ResPartMessage
ResPartWarnings
ResPartTicket
ResPartSessionId
ResPartViewerSettingsVersion
ResPartDecryptedTicket
ResPartAuthorizationGroup
ResPartActions
ResPartTemplates
ResPartModel
ResPartFile
ResPartStatistic
ResPartSetting
ResPartParameters
ResPartPlugins
ResPartViewer
ResPartOutputs
ResPartExports
ResPartAnalytics
ResPartGltfUpload
ResPartModelComputation
ResPartModelState
ResPartModelStateData
ResPartPagination
ResPartCleanup
ResPagination
ResAnalytics
ResModelStatistic
ResOnDurationStatistic
ResOnActionStatistic
ResAnyCreditMetric
ResBaseCreditMetric
ResLimitedCreditMetric
ResDefaultCreditMetric
ResAsset
ResAssetDefinition
ResExportDefinitionType
ResExportDefinition
ResExport
ResExportContent
ResExportOrDefinition
ResList
ResFileInfo
ResSdtfInfo
ResAction
ResTemplate
ResModel
ResModelStatus
ResFile
ResPlugins
ResStatistic
ResParameter
ResParameterType
ResVisualizationType
ResStructureType
ResViewer
ResTicket
ResTicketType
ResGltfUpload
ResModelCleanupProcess
ResModelCleanupProcessType
ResTexture
ResModelComputation
ResModelState
ResModelStateData
ResModelStateInfo
ResBasicParameter
ResStypeParameter
ResParameterValue
ResModelComputationStats
ResComputedComponent
ResComputingComponent
ResWarningComponent
ResErrorComponent
ResComputationComponent
ResComputationComponents
ResComputationStatus
ResComputationLimits
ResOutputDefinition
ResOutput
ResOutputContent
ResOutputChunk
ResOutputOrDefinition
ResSettings
ResAuthorizationSettings
ResTicketAuthorization
ResTokenAuthorization
ResComputeSettings
ResModelSettings
ResSystem
ResMinionInfo
ResMinionProcess
ResMinionTask
ResWorkerInfo
ResWorkerPlugins
ResInstalledWorkerPlugin
ResAllowedWorkerPlugin
ResWorkerPluginComponent
ResError
ResErrorType