AccountResource

Accounts contain billing-related information for a team or user.

This interface was referenced by V1's JSON-Schema via the definition "AccountResource".

BakeExportData

the export parameters

This interface was referenced by V1's JSON-Schema via the definition "BakeExportData".

Body

This interface was referenced by V1's JSON-Schema via the definition "Body".

DesignGenerationData

This interface was referenced by V1's JSON-Schema via the definition "DesignGenerationData".

DesignGenerationResult

DesignIdentity

This interface was referenced by V1's JSON-Schema via the definition "DesignIdentity".

DesignResource

A Design resource

This interface was referenced by V1's JSON-Schema via the definition "DesignResource".

EventIdentity

This interface was referenced by V1's JSON-Schema via the definition "EventIdentity".

EventResource

Events are images that can be used as the _event_ of a [Placement](/docs/api/reference/schemas/PlacementResource).

This interface was referenced by V1's JSON-Schema via the definition "EventResource".

ExportIdentity

This interface was referenced by V1's JSON-Schema via the definition "ExportIdentity".

ExportResource

An Export resource

This interface was referenced by V1's JSON-Schema via the definition "ExportResource".

GenerationIdentity

This interface was referenced by V1's JSON-Schema via the definition "GenerationIdentity".

GenerationResource

A Generation Resource

This interface was referenced by V1's JSON-Schema via the definition "GenerationResource".

ImageGenerationData

Data for image generations.

This interface was referenced by V1's JSON-Schema via the definition "ImageGenerationData".

ImageGenerationResult

LifestyleGenerationData

Data for lifestyle generations.

This interface was referenced by V1's JSON-Schema via the definition "LifestyleGenerationData".

LifestyleGenerationResult

MaterialIdentity

This interface was referenced by V1's JSON-Schema via the definition "MaterialIdentity".

MaterialResource

A Material resource

This interface was referenced by V1's JSON-Schema via the definition "MaterialResource".

MetafieldDefinitionIdentity

This interface was referenced by V1's JSON-Schema via the definition "MetafieldDefinitionIdentity".

MetafieldDefinitionResource

This interface was referenced by V1's JSON-Schema via the definition "MetafieldDefinitionResource".

MetafieldIdentity

This interface was referenced by V1's JSON-Schema via the definition "MetafieldIdentity".

MetafieldResource

This interface was referenced by V1's JSON-Schema via the definition "MetafieldResource".

ModelIdentity

This interface was referenced by V1's JSON-Schema via the definition "ModelIdentity".

ModelLinkIdentity

This interface was referenced by V1's JSON-Schema via the definition "ModelLinkIdentity".

ModelLinkMapping

A mapping from source model to target model.

This interface was referenced by V1's JSON-Schema via the definition "ModelLinkMapping".

ModelLinkResource

ModelLinks tie two distinct Models together to represent some type of shared functionality.

For example, you might create a link between a model representing a physical t-shirt, and a model representing a t-shirt in Roblox to allow users to reproject Designs between the two.

Or, as a manufacturer you might upgrade your t-shirt pattern over time, so to prevent existing Designs from breaking, you create a ModelLink between the two to facilitate a transfer to the new Model.

Models also provide varying capabilities (AOP, DTG, various export types, etc.). You may want to link two Models together to effectively expand the capabilities you have access to when designing on a Model.

This interface was referenced by V1's JSON-Schema via the definition "ModelLinkResource".

ModelResource

This interface was referenced by V1's JSON-Schema via the definition "ModelResource".

ModelZone

This interface was referenced by V1's JSON-Schema via the definition "ModelZone".

PresetExportData

the export parameters

This interface was referenced by V1's JSON-Schema via the definition "PresetExportData".

TeamIdentity

This interface was referenced by V1's JSON-Schema via the definition "TeamIdentity".

TeamMemberIdentity

This interface was referenced by V1's JSON-Schema via the definition "TeamMemberIdentity".

TeamMemberResource

This interface was referenced by V1's JSON-Schema via the definition "TeamMemberResource".

TeamResource

This interface was referenced by V1's JSON-Schema via the definition "TeamResource".

TokenIdentity

This interface was referenced by V1's JSON-Schema via the definition "TokenIdentity".

TokenResource

This interface was referenced by V1's JSON-Schema via the definition "TokenResource".

UpdateModelLinkRequestBody

This interface was referenced by V1's JSON-Schema via the definition "UpdateModelLinkRequestBody".

UploadIdentity

This interface was referenced by V1's JSON-Schema via the definition "UploadIdentity".

UploadResource

This interface was referenced by V1's JSON-Schema via the definition "UploadResource".

UploadVariantResource

This interface was referenced by V1's JSON-Schema via the definition "UploadVariantResource".

UserIdentity

This interface was referenced by V1's JSON-Schema via the definition "UserIdentity".

UserResource

This interface was referenced by V1's JSON-Schema via the definition "UserResource".

V1

WebhookCreateBody

This interface was referenced by V1's JSON-Schema via the definition "WebhookCreateBody".

WebhookDeliveryIdentity

This interface was referenced by V1's JSON-Schema via the definition "WebhookDeliveryIdentity".

WebhookDeliveryResource

Webhook Deliveries describe delivery events to registered Webhooks.

This interface was referenced by V1's JSON-Schema via the definition "WebhookDeliveryResource".

WebhookIdentity

This interface was referenced by V1's JSON-Schema via the definition "WebhookIdentity".

WebhookResource

Webhooks allow you to tap into events within Core3D as they occur.

This interface was referenced by V1's JSON-Schema via the definition "WebhookResource".

Active

The default account state.

Delinquent

An account becomes delinquent when one or more invoices are past due.

DesignIdentityParameter

This interface was referenced by V1's JSON-Schema via the definition "DesignIdentityParameter".

EventIdentityParameter

This interface was referenced by V1's JSON-Schema via the definition "EventIdentityParameter".

ExportIdentityParameter

This interface was referenced by V1's JSON-Schema via the definition "ExportIdentityParameter".

GenerationIdentityParameter

This interface was referenced by V1's JSON-Schema via the definition "GenerationIdentityParameter".

GenerationResult

Immutable

Internal use.

Inactive

An account can be deactivated by the user, an administrator, or automatically if there was no usage for a period of time. After deactivation the account will no longer be invoiced for usage and must be explicitly reactivated via the dashboard or API to enable further usage.

If your account is deactivated you won't receive notifications for future account events, you won't be able to use most of the API, and you won't be able to install the SDK. Reactivation will also require agreeing to the latest pricing terms.

MaterialIdentityParameter

This interface was referenced by V1's JSON-Schema via the definition "MaterialIdentityParameter".

MetafieldData

Metafield creation data

This interface was referenced by V1's JSON-Schema via the definition "MetafieldData".

MetafieldDefinitionIdentityParameter

This interface was referenced by V1's JSON-Schema via the definition "MetafieldDefinitionIdentityParameter".

MetafieldIdentityParameter

This interface was referenced by V1's JSON-Schema via the definition "MetafieldIdentityParameter".

ModelIdentityParameter

This interface was referenced by V1's JSON-Schema via the definition "ModelIdentityParameter".

ModelLinkIdentityParameter

This interface was referenced by V1's JSON-Schema via the definition "ModelLinkIdentityParameter".

ModelTargetParameter

This interface was referenced by V1's JSON-Schema via the definition "ModelTargetParameter".

NodeURI

This interface was referenced by V1's JSON-Schema via the definition "NodeURI".

Predelinquent

An account become predelinquent when it's close to becoming delinquent.

Stagnant

An account will automatically become stagnant after three months of no activity. Stagnant accounts will be scheduled for deactivation.

Suspended

An account will be suspended if an invoice is past due by 10 or more days.

If your account is suspended you won't be able to use most of the API or install the SDK. You must pay your invoice(s) to move the account back to a normal status.

TeamIdentityParameter

This interface was referenced by V1's JSON-Schema via the definition "TeamIdentityParameter".

TeamMemberIdentityParameter

This interface was referenced by V1's JSON-Schema via the definition "TeamMemberIdentityParameter".

TokenIdentityParameter

This interface was referenced by V1's JSON-Schema via the definition "TokenIdentityParameter".

Undefined

Provides a way to specify an unmatchable undefined value.

This interface was referenced by V1's JSON-Schema via the definition "Undefined".

UploadIdentityParameter

This interface was referenced by V1's JSON-Schema via the definition "UploadIdentityParameter".

UploadVariantIdentityParameter

This interface was referenced by V1's JSON-Schema via the definition "UploadVariantIdentityParameter".

UserIdentityParameter

This interface was referenced by V1's JSON-Schema via the definition "UserIdentityParameter".

WebhookIdentityParameter

This interface was referenced by V1's JSON-Schema via the definition "WebhookIdentityParameter".