New to Corsair? See API access, authentication, and error handling.
Embeds
delete
embeds.delete
Delete an embed. This cannot be undone.
Risk: destructive
await corsair.modelry.api.embeds.delete({});
| Name | Type | Required | Description |
|---|---|---|---|
product_id | string | number | Yes | — |
id | string | number | Yes | — |
void
get
embeds.get
Get one embed, with its public viewer URL and loader script configuration.
Risk: read
await corsair.modelry.api.embeds.get({});
| Name | Type | Required | Description |
|---|---|---|---|
product_id | string | number | Yes | — |
id | string | number | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
data | object | Yes | — |
included | object[] | No | — |
meta | object | No | — |
data full type
data full type
{
id: string,
type: string,
attributes?: {
uid?: string | null,
sku?: string | null,
title?: string | null,
name?: string | null,
createdAt?: string | null,
batchID?: string | null,
batchId?: string | null,
batchUid?: string | null,
deliveredAt?: string | null,
status?: string | null,
pipeline?: string | null,
price?: string | null,
previewImageUrl?: string | null,
dimensions?: string | null,
productUrl?: string | null,
productId?: number | null,
requestType?: string | null,
inCustomerQa?: boolean | null,
customerQaUrl?: string | null,
currentRoundNumber?: number | null,
currentRoundSaved?: boolean | null,
referenceFileUrls?: string[] | null,
reviewCategories?: {
id: string,
title: string
}[] | null,
description?: string | null,
tags?: string[] | null,
sourceLabel?: string | null,
toolKinds?: string[] | null,
contentLabels?: string[] | null,
byteSize?: number | string | null,
labels?: string[] | null,
url?: string | null,
fileName?: string | null,
kinds?: string[] | null,
published?: boolean | null,
loaderScriptConfiguration?: Record<string, any>[] | null,
adminIssueId?: string | null,
annotation?: Record<string, any> | null,
authorId?: string | null,
authorRole?: string | null,
authorUsername?: string | null,
category?: string | null,
comment?: string | null,
data?: Record<string, any> | null,
deletedAt?: string | null,
destroyed?: boolean | null,
displayAuthorUsername?: boolean | null,
displayIssueChanges?: boolean | null,
displaySeverity?: boolean | null,
disputeComment?: string | null,
disputeReason?: string | null,
disputeRejectionReason?: string | null,
disputeStatus?: string | null,
draft?: boolean | null,
editorUsername?: string | null,
isReviewed?: boolean | null,
issueLogs?: string[] | null,
order?: number | null,
origin?: string | null,
reviewableAttachmentId?: string | null,
reviewed?: boolean | null,
severity?: number | null,
solved?: boolean | null,
state?: string | null,
updatedAt?: string | null,
x?: string | null,
y?: string | null
},
relationships?: Record<string, any>
}
included full type
included full type
{
id: string,
type: string,
attributes?: {
uid?: string | null,
sku?: string | null,
title?: string | null,
name?: string | null,
createdAt?: string | null,
batchID?: string | null,
batchId?: string | null,
batchUid?: string | null,
deliveredAt?: string | null,
status?: string | null,
pipeline?: string | null,
price?: string | null,
previewImageUrl?: string | null,
dimensions?: string | null,
productUrl?: string | null,
productId?: number | null,
requestType?: string | null,
inCustomerQa?: boolean | null,
customerQaUrl?: string | null,
currentRoundNumber?: number | null,
currentRoundSaved?: boolean | null,
referenceFileUrls?: string[] | null,
reviewCategories?: {
id: string,
title: string
}[] | null,
description?: string | null,
tags?: string[] | null,
sourceLabel?: string | null,
toolKinds?: string[] | null,
contentLabels?: string[] | null,
byteSize?: number | string | null,
labels?: string[] | null,
url?: string | null,
fileName?: string | null,
kinds?: string[] | null,
published?: boolean | null,
loaderScriptConfiguration?: Record<string, any>[] | null,
adminIssueId?: string | null,
annotation?: Record<string, any> | null,
authorId?: string | null,
authorRole?: string | null,
authorUsername?: string | null,
category?: string | null,
comment?: string | null,
data?: Record<string, any> | null,
deletedAt?: string | null,
destroyed?: boolean | null,
displayAuthorUsername?: boolean | null,
displayIssueChanges?: boolean | null,
displaySeverity?: boolean | null,
disputeComment?: string | null,
disputeReason?: string | null,
disputeRejectionReason?: string | null,
disputeStatus?: string | null,
draft?: boolean | null,
editorUsername?: string | null,
isReviewed?: boolean | null,
issueLogs?: string[] | null,
order?: number | null,
origin?: string | null,
reviewableAttachmentId?: string | null,
reviewed?: boolean | null,
severity?: number | null,
solved?: boolean | null,
state?: string | null,
updatedAt?: string | null,
x?: string | null,
y?: string | null
},
relationships?: Record<string, any>
}[]
meta full type
meta full type
{
page?: number | null,
per_page?: number | null,
total_pages?: number | null,
total_records?: number | null
}
list
embeds.list
List a product’s 3D/AR web viewers (embeds). An empty result is returned as an empty list.
Risk: read
await corsair.modelry.api.embeds.list({});
| Name | Type | Required | Description |
|---|---|---|---|
product_id | string | number | Yes | — |
page | number | No | — |
per_page | number | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
data | object[] | Yes | — |
meta | object | No | — |
data full type
data full type
{
id: string,
type: string,
attributes?: {
uid?: string | null,
sku?: string | null,
title?: string | null,
name?: string | null,
createdAt?: string | null,
batchID?: string | null,
batchId?: string | null,
batchUid?: string | null,
deliveredAt?: string | null,
status?: string | null,
pipeline?: string | null,
price?: string | null,
previewImageUrl?: string | null,
dimensions?: string | null,
productUrl?: string | null,
productId?: number | null,
requestType?: string | null,
inCustomerQa?: boolean | null,
customerQaUrl?: string | null,
currentRoundNumber?: number | null,
currentRoundSaved?: boolean | null,
referenceFileUrls?: string[] | null,
reviewCategories?: {
id: string,
title: string
}[] | null,
description?: string | null,
tags?: string[] | null,
sourceLabel?: string | null,
toolKinds?: string[] | null,
contentLabels?: string[] | null,
byteSize?: number | string | null,
labels?: string[] | null,
url?: string | null,
fileName?: string | null,
kinds?: string[] | null,
published?: boolean | null,
loaderScriptConfiguration?: Record<string, any>[] | null,
adminIssueId?: string | null,
annotation?: Record<string, any> | null,
authorId?: string | null,
authorRole?: string | null,
authorUsername?: string | null,
category?: string | null,
comment?: string | null,
data?: Record<string, any> | null,
deletedAt?: string | null,
destroyed?: boolean | null,
displayAuthorUsername?: boolean | null,
displayIssueChanges?: boolean | null,
displaySeverity?: boolean | null,
disputeComment?: string | null,
disputeReason?: string | null,
disputeRejectionReason?: string | null,
disputeStatus?: string | null,
draft?: boolean | null,
editorUsername?: string | null,
isReviewed?: boolean | null,
issueLogs?: string[] | null,
order?: number | null,
origin?: string | null,
reviewableAttachmentId?: string | null,
reviewed?: boolean | null,
severity?: number | null,
solved?: boolean | null,
state?: string | null,
updatedAt?: string | null,
x?: string | null,
y?: string | null
},
relationships?: Record<string, any>
}[]
meta full type
meta full type
{
page?: number | null,
per_page?: number | null,
total_pages?: number | null,
total_records?: number | null
}
publish
embeds.publish
Publish an embed so its viewer URL is publicly reachable.
Risk: write
await corsair.modelry.api.embeds.publish({});
| Name | Type | Required | Description |
|---|---|---|---|
product_id | string | number | Yes | — |
id | string | number | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
data | object | Yes | — |
included | object[] | No | — |
meta | object | No | — |
data full type
data full type
{
id: string,
type: string,
attributes?: {
uid?: string | null,
sku?: string | null,
title?: string | null,
name?: string | null,
createdAt?: string | null,
batchID?: string | null,
batchId?: string | null,
batchUid?: string | null,
deliveredAt?: string | null,
status?: string | null,
pipeline?: string | null,
price?: string | null,
previewImageUrl?: string | null,
dimensions?: string | null,
productUrl?: string | null,
productId?: number | null,
requestType?: string | null,
inCustomerQa?: boolean | null,
customerQaUrl?: string | null,
currentRoundNumber?: number | null,
currentRoundSaved?: boolean | null,
referenceFileUrls?: string[] | null,
reviewCategories?: {
id: string,
title: string
}[] | null,
description?: string | null,
tags?: string[] | null,
sourceLabel?: string | null,
toolKinds?: string[] | null,
contentLabels?: string[] | null,
byteSize?: number | string | null,
labels?: string[] | null,
url?: string | null,
fileName?: string | null,
kinds?: string[] | null,
published?: boolean | null,
loaderScriptConfiguration?: Record<string, any>[] | null,
adminIssueId?: string | null,
annotation?: Record<string, any> | null,
authorId?: string | null,
authorRole?: string | null,
authorUsername?: string | null,
category?: string | null,
comment?: string | null,
data?: Record<string, any> | null,
deletedAt?: string | null,
destroyed?: boolean | null,
displayAuthorUsername?: boolean | null,
displayIssueChanges?: boolean | null,
displaySeverity?: boolean | null,
disputeComment?: string | null,
disputeReason?: string | null,
disputeRejectionReason?: string | null,
disputeStatus?: string | null,
draft?: boolean | null,
editorUsername?: string | null,
isReviewed?: boolean | null,
issueLogs?: string[] | null,
order?: number | null,
origin?: string | null,
reviewableAttachmentId?: string | null,
reviewed?: boolean | null,
severity?: number | null,
solved?: boolean | null,
state?: string | null,
updatedAt?: string | null,
x?: string | null,
y?: string | null
},
relationships?: Record<string, any>
}
included full type
included full type
{
id: string,
type: string,
attributes?: {
uid?: string | null,
sku?: string | null,
title?: string | null,
name?: string | null,
createdAt?: string | null,
batchID?: string | null,
batchId?: string | null,
batchUid?: string | null,
deliveredAt?: string | null,
status?: string | null,
pipeline?: string | null,
price?: string | null,
previewImageUrl?: string | null,
dimensions?: string | null,
productUrl?: string | null,
productId?: number | null,
requestType?: string | null,
inCustomerQa?: boolean | null,
customerQaUrl?: string | null,
currentRoundNumber?: number | null,
currentRoundSaved?: boolean | null,
referenceFileUrls?: string[] | null,
reviewCategories?: {
id: string,
title: string
}[] | null,
description?: string | null,
tags?: string[] | null,
sourceLabel?: string | null,
toolKinds?: string[] | null,
contentLabels?: string[] | null,
byteSize?: number | string | null,
labels?: string[] | null,
url?: string | null,
fileName?: string | null,
kinds?: string[] | null,
published?: boolean | null,
loaderScriptConfiguration?: Record<string, any>[] | null,
adminIssueId?: string | null,
annotation?: Record<string, any> | null,
authorId?: string | null,
authorRole?: string | null,
authorUsername?: string | null,
category?: string | null,
comment?: string | null,
data?: Record<string, any> | null,
deletedAt?: string | null,
destroyed?: boolean | null,
displayAuthorUsername?: boolean | null,
displayIssueChanges?: boolean | null,
displaySeverity?: boolean | null,
disputeComment?: string | null,
disputeReason?: string | null,
disputeRejectionReason?: string | null,
disputeStatus?: string | null,
draft?: boolean | null,
editorUsername?: string | null,
isReviewed?: boolean | null,
issueLogs?: string[] | null,
order?: number | null,
origin?: string | null,
reviewableAttachmentId?: string | null,
reviewed?: boolean | null,
severity?: number | null,
solved?: boolean | null,
state?: string | null,
updatedAt?: string | null,
x?: string | null,
y?: string | null
},
relationships?: Record<string, any>
}[]
meta full type
meta full type
{
page?: number | null,
per_page?: number | null,
total_pages?: number | null,
total_records?: number | null
}
Modeling Requests
approve
modelingRequests.approve
Accept a delivered model and finish customer QA. The API cannot undo an approval.
Risk: destructive
await corsair.modelry.api.modelingRequests.approve({});
| Name | Type | Required | Description |
|---|---|---|---|
id_or_sku | string | number | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
data | object | Yes | — |
included | object[] | No | — |
meta | object | No | — |
data full type
data full type
{
id: string,
type: string,
attributes?: {
uid?: string | null,
sku?: string | null,
title?: string | null,
name?: string | null,
createdAt?: string | null,
batchID?: string | null,
batchId?: string | null,
batchUid?: string | null,
deliveredAt?: string | null,
status?: string | null,
pipeline?: string | null,
price?: string | null,
previewImageUrl?: string | null,
dimensions?: string | null,
productUrl?: string | null,
productId?: number | null,
requestType?: string | null,
inCustomerQa?: boolean | null,
customerQaUrl?: string | null,
currentRoundNumber?: number | null,
currentRoundSaved?: boolean | null,
referenceFileUrls?: string[] | null,
reviewCategories?: {
id: string,
title: string
}[] | null,
description?: string | null,
tags?: string[] | null,
sourceLabel?: string | null,
toolKinds?: string[] | null,
contentLabels?: string[] | null,
byteSize?: number | string | null,
labels?: string[] | null,
url?: string | null,
fileName?: string | null,
kinds?: string[] | null,
published?: boolean | null,
loaderScriptConfiguration?: Record<string, any>[] | null,
adminIssueId?: string | null,
annotation?: Record<string, any> | null,
authorId?: string | null,
authorRole?: string | null,
authorUsername?: string | null,
category?: string | null,
comment?: string | null,
data?: Record<string, any> | null,
deletedAt?: string | null,
destroyed?: boolean | null,
displayAuthorUsername?: boolean | null,
displayIssueChanges?: boolean | null,
displaySeverity?: boolean | null,
disputeComment?: string | null,
disputeReason?: string | null,
disputeRejectionReason?: string | null,
disputeStatus?: string | null,
draft?: boolean | null,
editorUsername?: string | null,
isReviewed?: boolean | null,
issueLogs?: string[] | null,
order?: number | null,
origin?: string | null,
reviewableAttachmentId?: string | null,
reviewed?: boolean | null,
severity?: number | null,
solved?: boolean | null,
state?: string | null,
updatedAt?: string | null,
x?: string | null,
y?: string | null
},
relationships?: Record<string, any>
}
included full type
included full type
{
id: string,
type: string,
attributes?: {
uid?: string | null,
sku?: string | null,
title?: string | null,
name?: string | null,
createdAt?: string | null,
batchID?: string | null,
batchId?: string | null,
batchUid?: string | null,
deliveredAt?: string | null,
status?: string | null,
pipeline?: string | null,
price?: string | null,
previewImageUrl?: string | null,
dimensions?: string | null,
productUrl?: string | null,
productId?: number | null,
requestType?: string | null,
inCustomerQa?: boolean | null,
customerQaUrl?: string | null,
currentRoundNumber?: number | null,
currentRoundSaved?: boolean | null,
referenceFileUrls?: string[] | null,
reviewCategories?: {
id: string,
title: string
}[] | null,
description?: string | null,
tags?: string[] | null,
sourceLabel?: string | null,
toolKinds?: string[] | null,
contentLabels?: string[] | null,
byteSize?: number | string | null,
labels?: string[] | null,
url?: string | null,
fileName?: string | null,
kinds?: string[] | null,
published?: boolean | null,
loaderScriptConfiguration?: Record<string, any>[] | null,
adminIssueId?: string | null,
annotation?: Record<string, any> | null,
authorId?: string | null,
authorRole?: string | null,
authorUsername?: string | null,
category?: string | null,
comment?: string | null,
data?: Record<string, any> | null,
deletedAt?: string | null,
destroyed?: boolean | null,
displayAuthorUsername?: boolean | null,
displayIssueChanges?: boolean | null,
displaySeverity?: boolean | null,
disputeComment?: string | null,
disputeReason?: string | null,
disputeRejectionReason?: string | null,
disputeStatus?: string | null,
draft?: boolean | null,
editorUsername?: string | null,
isReviewed?: boolean | null,
issueLogs?: string[] | null,
order?: number | null,
origin?: string | null,
reviewableAttachmentId?: string | null,
reviewed?: boolean | null,
severity?: number | null,
solved?: boolean | null,
state?: string | null,
updatedAt?: string | null,
x?: string | null,
y?: string | null
},
relationships?: Record<string, any>
}[]
meta full type
meta full type
{
page?: number | null,
per_page?: number | null,
total_pages?: number | null,
total_records?: number | null
}
assets
modelingRequests.assets
List the files delivered for a modeling request (models, renders, textures) with download URLs.
Risk: read
await corsair.modelry.api.modelingRequests.assets({});
| Name | Type | Required | Description |
|---|---|---|---|
modeling_request_id_or_sku | string | number | Yes | — |
page | number | No | — |
per_page | number | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
data | object[] | Yes | — |
meta | object | No | — |
data full type
data full type
{
id: string,
type: string,
attributes?: {
uid?: string | null,
sku?: string | null,
title?: string | null,
name?: string | null,
createdAt?: string | null,
batchID?: string | null,
batchId?: string | null,
batchUid?: string | null,
deliveredAt?: string | null,
status?: string | null,
pipeline?: string | null,
price?: string | null,
previewImageUrl?: string | null,
dimensions?: string | null,
productUrl?: string | null,
productId?: number | null,
requestType?: string | null,
inCustomerQa?: boolean | null,
customerQaUrl?: string | null,
currentRoundNumber?: number | null,
currentRoundSaved?: boolean | null,
referenceFileUrls?: string[] | null,
reviewCategories?: {
id: string,
title: string
}[] | null,
description?: string | null,
tags?: string[] | null,
sourceLabel?: string | null,
toolKinds?: string[] | null,
contentLabels?: string[] | null,
byteSize?: number | string | null,
labels?: string[] | null,
url?: string | null,
fileName?: string | null,
kinds?: string[] | null,
published?: boolean | null,
loaderScriptConfiguration?: Record<string, any>[] | null,
adminIssueId?: string | null,
annotation?: Record<string, any> | null,
authorId?: string | null,
authorRole?: string | null,
authorUsername?: string | null,
category?: string | null,
comment?: string | null,
data?: Record<string, any> | null,
deletedAt?: string | null,
destroyed?: boolean | null,
displayAuthorUsername?: boolean | null,
displayIssueChanges?: boolean | null,
displaySeverity?: boolean | null,
disputeComment?: string | null,
disputeReason?: string | null,
disputeRejectionReason?: string | null,
disputeStatus?: string | null,
draft?: boolean | null,
editorUsername?: string | null,
isReviewed?: boolean | null,
issueLogs?: string[] | null,
order?: number | null,
origin?: string | null,
reviewableAttachmentId?: string | null,
reviewed?: boolean | null,
severity?: number | null,
solved?: boolean | null,
state?: string | null,
updatedAt?: string | null,
x?: string | null,
y?: string | null
},
relationships?: Record<string, any>
}[]
meta full type
meta full type
{
page?: number | null,
per_page?: number | null,
total_pages?: number | null,
total_records?: number | null
}
create
modelingRequests.create
Order a custom 3D model from Modelry. Modelry quotes and bills per model, and the API has no cancel.
Risk: destructive
await corsair.modelry.api.modelingRequests.create({});
| Name | Type | Required | Description |
|---|---|---|---|
modeling_request | object | Yes | — |
modeling_request full type
modeling_request full type
{
title: string,
sku: string,
product_id?: number,
dimensions?: string,
pipeline: high_poly | low_poly,
specific_requirements?: string,
external_url?: string,
reference_file_blob_ids?: string[]
}
| Name | Type | Required | Description |
|---|---|---|---|
data | object | Yes | — |
included | object[] | No | — |
meta | object | No | — |
data full type
data full type
{
id: string,
type: string,
attributes?: {
uid?: string | null,
sku?: string | null,
title?: string | null,
name?: string | null,
createdAt?: string | null,
batchID?: string | null,
batchId?: string | null,
batchUid?: string | null,
deliveredAt?: string | null,
status?: string | null,
pipeline?: string | null,
price?: string | null,
previewImageUrl?: string | null,
dimensions?: string | null,
productUrl?: string | null,
productId?: number | null,
requestType?: string | null,
inCustomerQa?: boolean | null,
customerQaUrl?: string | null,
currentRoundNumber?: number | null,
currentRoundSaved?: boolean | null,
referenceFileUrls?: string[] | null,
reviewCategories?: {
id: string,
title: string
}[] | null,
description?: string | null,
tags?: string[] | null,
sourceLabel?: string | null,
toolKinds?: string[] | null,
contentLabels?: string[] | null,
byteSize?: number | string | null,
labels?: string[] | null,
url?: string | null,
fileName?: string | null,
kinds?: string[] | null,
published?: boolean | null,
loaderScriptConfiguration?: Record<string, any>[] | null,
adminIssueId?: string | null,
annotation?: Record<string, any> | null,
authorId?: string | null,
authorRole?: string | null,
authorUsername?: string | null,
category?: string | null,
comment?: string | null,
data?: Record<string, any> | null,
deletedAt?: string | null,
destroyed?: boolean | null,
displayAuthorUsername?: boolean | null,
displayIssueChanges?: boolean | null,
displaySeverity?: boolean | null,
disputeComment?: string | null,
disputeReason?: string | null,
disputeRejectionReason?: string | null,
disputeStatus?: string | null,
draft?: boolean | null,
editorUsername?: string | null,
isReviewed?: boolean | null,
issueLogs?: string[] | null,
order?: number | null,
origin?: string | null,
reviewableAttachmentId?: string | null,
reviewed?: boolean | null,
severity?: number | null,
solved?: boolean | null,
state?: string | null,
updatedAt?: string | null,
x?: string | null,
y?: string | null
},
relationships?: Record<string, any>
}
included full type
included full type
{
id: string,
type: string,
attributes?: {
uid?: string | null,
sku?: string | null,
title?: string | null,
name?: string | null,
createdAt?: string | null,
batchID?: string | null,
batchId?: string | null,
batchUid?: string | null,
deliveredAt?: string | null,
status?: string | null,
pipeline?: string | null,
price?: string | null,
previewImageUrl?: string | null,
dimensions?: string | null,
productUrl?: string | null,
productId?: number | null,
requestType?: string | null,
inCustomerQa?: boolean | null,
customerQaUrl?: string | null,
currentRoundNumber?: number | null,
currentRoundSaved?: boolean | null,
referenceFileUrls?: string[] | null,
reviewCategories?: {
id: string,
title: string
}[] | null,
description?: string | null,
tags?: string[] | null,
sourceLabel?: string | null,
toolKinds?: string[] | null,
contentLabels?: string[] | null,
byteSize?: number | string | null,
labels?: string[] | null,
url?: string | null,
fileName?: string | null,
kinds?: string[] | null,
published?: boolean | null,
loaderScriptConfiguration?: Record<string, any>[] | null,
adminIssueId?: string | null,
annotation?: Record<string, any> | null,
authorId?: string | null,
authorRole?: string | null,
authorUsername?: string | null,
category?: string | null,
comment?: string | null,
data?: Record<string, any> | null,
deletedAt?: string | null,
destroyed?: boolean | null,
displayAuthorUsername?: boolean | null,
displayIssueChanges?: boolean | null,
displaySeverity?: boolean | null,
disputeComment?: string | null,
disputeReason?: string | null,
disputeRejectionReason?: string | null,
disputeStatus?: string | null,
draft?: boolean | null,
editorUsername?: string | null,
isReviewed?: boolean | null,
issueLogs?: string[] | null,
order?: number | null,
origin?: string | null,
reviewableAttachmentId?: string | null,
reviewed?: boolean | null,
severity?: number | null,
solved?: boolean | null,
state?: string | null,
updatedAt?: string | null,
x?: string | null,
y?: string | null
},
relationships?: Record<string, any>
}[]
meta full type
meta full type
{
page?: number | null,
per_page?: number | null,
total_pages?: number | null,
total_records?: number | null
}
get
modelingRequests.get
Get one modeling request by id or SKU: status, price, QA round and review categories.
Risk: read
await corsair.modelry.api.modelingRequests.get({});
| Name | Type | Required | Description |
|---|---|---|---|
id_or_sku | string | number | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
data | object | Yes | — |
included | object[] | No | — |
meta | object | No | — |
data full type
data full type
{
id: string,
type: string,
attributes?: {
uid?: string | null,
sku?: string | null,
title?: string | null,
name?: string | null,
createdAt?: string | null,
batchID?: string | null,
batchId?: string | null,
batchUid?: string | null,
deliveredAt?: string | null,
status?: string | null,
pipeline?: string | null,
price?: string | null,
previewImageUrl?: string | null,
dimensions?: string | null,
productUrl?: string | null,
productId?: number | null,
requestType?: string | null,
inCustomerQa?: boolean | null,
customerQaUrl?: string | null,
currentRoundNumber?: number | null,
currentRoundSaved?: boolean | null,
referenceFileUrls?: string[] | null,
reviewCategories?: {
id: string,
title: string
}[] | null,
description?: string | null,
tags?: string[] | null,
sourceLabel?: string | null,
toolKinds?: string[] | null,
contentLabels?: string[] | null,
byteSize?: number | string | null,
labels?: string[] | null,
url?: string | null,
fileName?: string | null,
kinds?: string[] | null,
published?: boolean | null,
loaderScriptConfiguration?: Record<string, any>[] | null,
adminIssueId?: string | null,
annotation?: Record<string, any> | null,
authorId?: string | null,
authorRole?: string | null,
authorUsername?: string | null,
category?: string | null,
comment?: string | null,
data?: Record<string, any> | null,
deletedAt?: string | null,
destroyed?: boolean | null,
displayAuthorUsername?: boolean | null,
displayIssueChanges?: boolean | null,
displaySeverity?: boolean | null,
disputeComment?: string | null,
disputeReason?: string | null,
disputeRejectionReason?: string | null,
disputeStatus?: string | null,
draft?: boolean | null,
editorUsername?: string | null,
isReviewed?: boolean | null,
issueLogs?: string[] | null,
order?: number | null,
origin?: string | null,
reviewableAttachmentId?: string | null,
reviewed?: boolean | null,
severity?: number | null,
solved?: boolean | null,
state?: string | null,
updatedAt?: string | null,
x?: string | null,
y?: string | null
},
relationships?: Record<string, any>
}
included full type
included full type
{
id: string,
type: string,
attributes?: {
uid?: string | null,
sku?: string | null,
title?: string | null,
name?: string | null,
createdAt?: string | null,
batchID?: string | null,
batchId?: string | null,
batchUid?: string | null,
deliveredAt?: string | null,
status?: string | null,
pipeline?: string | null,
price?: string | null,
previewImageUrl?: string | null,
dimensions?: string | null,
productUrl?: string | null,
productId?: number | null,
requestType?: string | null,
inCustomerQa?: boolean | null,
customerQaUrl?: string | null,
currentRoundNumber?: number | null,
currentRoundSaved?: boolean | null,
referenceFileUrls?: string[] | null,
reviewCategories?: {
id: string,
title: string
}[] | null,
description?: string | null,
tags?: string[] | null,
sourceLabel?: string | null,
toolKinds?: string[] | null,
contentLabels?: string[] | null,
byteSize?: number | string | null,
labels?: string[] | null,
url?: string | null,
fileName?: string | null,
kinds?: string[] | null,
published?: boolean | null,
loaderScriptConfiguration?: Record<string, any>[] | null,
adminIssueId?: string | null,
annotation?: Record<string, any> | null,
authorId?: string | null,
authorRole?: string | null,
authorUsername?: string | null,
category?: string | null,
comment?: string | null,
data?: Record<string, any> | null,
deletedAt?: string | null,
destroyed?: boolean | null,
displayAuthorUsername?: boolean | null,
displayIssueChanges?: boolean | null,
displaySeverity?: boolean | null,
disputeComment?: string | null,
disputeReason?: string | null,
disputeRejectionReason?: string | null,
disputeStatus?: string | null,
draft?: boolean | null,
editorUsername?: string | null,
isReviewed?: boolean | null,
issueLogs?: string[] | null,
order?: number | null,
origin?: string | null,
reviewableAttachmentId?: string | null,
reviewed?: boolean | null,
severity?: number | null,
solved?: boolean | null,
state?: string | null,
updatedAt?: string | null,
x?: string | null,
y?: string | null
},
relationships?: Record<string, any>
}[]
meta full type
meta full type
{
page?: number | null,
per_page?: number | null,
total_pages?: number | null,
total_records?: number | null
}
list
modelingRequests.list
List modeling requests (3D modelling orders), with workspace, SKU, batch and title filters.
Risk: read
await corsair.modelry.api.modelingRequests.list({});
| Name | Type | Required | Description |
|---|---|---|---|
page | number | No | — |
per_page | number | No | — |
workspace_id | number | No | — |
sort_by | string[] | No | — |
keywords | string | No | — |
sku | string | No | — |
batch_uid | string | No | — |
title | string | No | — |
status | in_quoting | in_progress | ready_for_review | adjustments_in_progress | dispute_review | preparing_for_delivery | finished | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
data | object[] | Yes | — |
meta | object | No | — |
data full type
data full type
{
id: string,
type: string,
attributes?: {
uid?: string | null,
sku?: string | null,
title?: string | null,
name?: string | null,
createdAt?: string | null,
batchID?: string | null,
batchId?: string | null,
batchUid?: string | null,
deliveredAt?: string | null,
status?: string | null,
pipeline?: string | null,
price?: string | null,
previewImageUrl?: string | null,
dimensions?: string | null,
productUrl?: string | null,
productId?: number | null,
requestType?: string | null,
inCustomerQa?: boolean | null,
customerQaUrl?: string | null,
currentRoundNumber?: number | null,
currentRoundSaved?: boolean | null,
referenceFileUrls?: string[] | null,
reviewCategories?: {
id: string,
title: string
}[] | null,
description?: string | null,
tags?: string[] | null,
sourceLabel?: string | null,
toolKinds?: string[] | null,
contentLabels?: string[] | null,
byteSize?: number | string | null,
labels?: string[] | null,
url?: string | null,
fileName?: string | null,
kinds?: string[] | null,
published?: boolean | null,
loaderScriptConfiguration?: Record<string, any>[] | null,
adminIssueId?: string | null,
annotation?: Record<string, any> | null,
authorId?: string | null,
authorRole?: string | null,
authorUsername?: string | null,
category?: string | null,
comment?: string | null,
data?: Record<string, any> | null,
deletedAt?: string | null,
destroyed?: boolean | null,
displayAuthorUsername?: boolean | null,
displayIssueChanges?: boolean | null,
displaySeverity?: boolean | null,
disputeComment?: string | null,
disputeReason?: string | null,
disputeRejectionReason?: string | null,
disputeStatus?: string | null,
draft?: boolean | null,
editorUsername?: string | null,
isReviewed?: boolean | null,
issueLogs?: string[] | null,
order?: number | null,
origin?: string | null,
reviewableAttachmentId?: string | null,
reviewed?: boolean | null,
severity?: number | null,
solved?: boolean | null,
state?: string | null,
updatedAt?: string | null,
x?: string | null,
y?: string | null
},
relationships?: Record<string, any>
}[]
meta full type
meta full type
{
page?: number | null,
per_page?: number | null,
total_pages?: number | null,
total_records?: number | null
}
reject
modelingRequests.reject
Reject a delivered model in customer QA and send it back to Modelry for adjustments. The API cannot undo a rejection.
Risk: destructive
await corsair.modelry.api.modelingRequests.reject({});
| Name | Type | Required | Description |
|---|---|---|---|
id_or_sku | string | number | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
data | object | Yes | — |
included | object[] | No | — |
meta | object | No | — |
data full type
data full type
{
id: string,
type: string,
attributes?: {
uid?: string | null,
sku?: string | null,
title?: string | null,
name?: string | null,
createdAt?: string | null,
batchID?: string | null,
batchId?: string | null,
batchUid?: string | null,
deliveredAt?: string | null,
status?: string | null,
pipeline?: string | null,
price?: string | null,
previewImageUrl?: string | null,
dimensions?: string | null,
productUrl?: string | null,
productId?: number | null,
requestType?: string | null,
inCustomerQa?: boolean | null,
customerQaUrl?: string | null,
currentRoundNumber?: number | null,
currentRoundSaved?: boolean | null,
referenceFileUrls?: string[] | null,
reviewCategories?: {
id: string,
title: string
}[] | null,
description?: string | null,
tags?: string[] | null,
sourceLabel?: string | null,
toolKinds?: string[] | null,
contentLabels?: string[] | null,
byteSize?: number | string | null,
labels?: string[] | null,
url?: string | null,
fileName?: string | null,
kinds?: string[] | null,
published?: boolean | null,
loaderScriptConfiguration?: Record<string, any>[] | null,
adminIssueId?: string | null,
annotation?: Record<string, any> | null,
authorId?: string | null,
authorRole?: string | null,
authorUsername?: string | null,
category?: string | null,
comment?: string | null,
data?: Record<string, any> | null,
deletedAt?: string | null,
destroyed?: boolean | null,
displayAuthorUsername?: boolean | null,
displayIssueChanges?: boolean | null,
displaySeverity?: boolean | null,
disputeComment?: string | null,
disputeReason?: string | null,
disputeRejectionReason?: string | null,
disputeStatus?: string | null,
draft?: boolean | null,
editorUsername?: string | null,
isReviewed?: boolean | null,
issueLogs?: string[] | null,
order?: number | null,
origin?: string | null,
reviewableAttachmentId?: string | null,
reviewed?: boolean | null,
severity?: number | null,
solved?: boolean | null,
state?: string | null,
updatedAt?: string | null,
x?: string | null,
y?: string | null
},
relationships?: Record<string, any>
}
included full type
included full type
{
id: string,
type: string,
attributes?: {
uid?: string | null,
sku?: string | null,
title?: string | null,
name?: string | null,
createdAt?: string | null,
batchID?: string | null,
batchId?: string | null,
batchUid?: string | null,
deliveredAt?: string | null,
status?: string | null,
pipeline?: string | null,
price?: string | null,
previewImageUrl?: string | null,
dimensions?: string | null,
productUrl?: string | null,
productId?: number | null,
requestType?: string | null,
inCustomerQa?: boolean | null,
customerQaUrl?: string | null,
currentRoundNumber?: number | null,
currentRoundSaved?: boolean | null,
referenceFileUrls?: string[] | null,
reviewCategories?: {
id: string,
title: string
}[] | null,
description?: string | null,
tags?: string[] | null,
sourceLabel?: string | null,
toolKinds?: string[] | null,
contentLabels?: string[] | null,
byteSize?: number | string | null,
labels?: string[] | null,
url?: string | null,
fileName?: string | null,
kinds?: string[] | null,
published?: boolean | null,
loaderScriptConfiguration?: Record<string, any>[] | null,
adminIssueId?: string | null,
annotation?: Record<string, any> | null,
authorId?: string | null,
authorRole?: string | null,
authorUsername?: string | null,
category?: string | null,
comment?: string | null,
data?: Record<string, any> | null,
deletedAt?: string | null,
destroyed?: boolean | null,
displayAuthorUsername?: boolean | null,
displayIssueChanges?: boolean | null,
displaySeverity?: boolean | null,
disputeComment?: string | null,
disputeReason?: string | null,
disputeRejectionReason?: string | null,
disputeStatus?: string | null,
draft?: boolean | null,
editorUsername?: string | null,
isReviewed?: boolean | null,
issueLogs?: string[] | null,
order?: number | null,
origin?: string | null,
reviewableAttachmentId?: string | null,
reviewed?: boolean | null,
severity?: number | null,
solved?: boolean | null,
state?: string | null,
updatedAt?: string | null,
x?: string | null,
y?: string | null
},
relationships?: Record<string, any>
}[]
meta full type
meta full type
{
page?: number | null,
per_page?: number | null,
total_pages?: number | null,
total_records?: number | null
}
Product Assets
create
productAssets.create
Attach an uploaded file to a product, using the signed blob id from uploads.file or uploads.blob.
Risk: write
await corsair.modelry.api.productAssets.create({});
| Name | Type | Required | Description |
|---|---|---|---|
product_id | string | number | Yes | — |
blob_id | string | Yes | — |
tags | string[] | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
data | object | Yes | — |
included | object[] | No | — |
meta | object | No | — |
data full type
data full type
{
id: string,
type: string,
attributes?: {
uid?: string | null,
sku?: string | null,
title?: string | null,
name?: string | null,
createdAt?: string | null,
batchID?: string | null,
batchId?: string | null,
batchUid?: string | null,
deliveredAt?: string | null,
status?: string | null,
pipeline?: string | null,
price?: string | null,
previewImageUrl?: string | null,
dimensions?: string | null,
productUrl?: string | null,
productId?: number | null,
requestType?: string | null,
inCustomerQa?: boolean | null,
customerQaUrl?: string | null,
currentRoundNumber?: number | null,
currentRoundSaved?: boolean | null,
referenceFileUrls?: string[] | null,
reviewCategories?: {
id: string,
title: string
}[] | null,
description?: string | null,
tags?: string[] | null,
sourceLabel?: string | null,
toolKinds?: string[] | null,
contentLabels?: string[] | null,
byteSize?: number | string | null,
labels?: string[] | null,
url?: string | null,
fileName?: string | null,
kinds?: string[] | null,
published?: boolean | null,
loaderScriptConfiguration?: Record<string, any>[] | null,
adminIssueId?: string | null,
annotation?: Record<string, any> | null,
authorId?: string | null,
authorRole?: string | null,
authorUsername?: string | null,
category?: string | null,
comment?: string | null,
data?: Record<string, any> | null,
deletedAt?: string | null,
destroyed?: boolean | null,
displayAuthorUsername?: boolean | null,
displayIssueChanges?: boolean | null,
displaySeverity?: boolean | null,
disputeComment?: string | null,
disputeReason?: string | null,
disputeRejectionReason?: string | null,
disputeStatus?: string | null,
draft?: boolean | null,
editorUsername?: string | null,
isReviewed?: boolean | null,
issueLogs?: string[] | null,
order?: number | null,
origin?: string | null,
reviewableAttachmentId?: string | null,
reviewed?: boolean | null,
severity?: number | null,
solved?: boolean | null,
state?: string | null,
updatedAt?: string | null,
x?: string | null,
y?: string | null
},
relationships?: Record<string, any>
}
included full type
included full type
{
id: string,
type: string,
attributes?: {
uid?: string | null,
sku?: string | null,
title?: string | null,
name?: string | null,
createdAt?: string | null,
batchID?: string | null,
batchId?: string | null,
batchUid?: string | null,
deliveredAt?: string | null,
status?: string | null,
pipeline?: string | null,
price?: string | null,
previewImageUrl?: string | null,
dimensions?: string | null,
productUrl?: string | null,
productId?: number | null,
requestType?: string | null,
inCustomerQa?: boolean | null,
customerQaUrl?: string | null,
currentRoundNumber?: number | null,
currentRoundSaved?: boolean | null,
referenceFileUrls?: string[] | null,
reviewCategories?: {
id: string,
title: string
}[] | null,
description?: string | null,
tags?: string[] | null,
sourceLabel?: string | null,
toolKinds?: string[] | null,
contentLabels?: string[] | null,
byteSize?: number | string | null,
labels?: string[] | null,
url?: string | null,
fileName?: string | null,
kinds?: string[] | null,
published?: boolean | null,
loaderScriptConfiguration?: Record<string, any>[] | null,
adminIssueId?: string | null,
annotation?: Record<string, any> | null,
authorId?: string | null,
authorRole?: string | null,
authorUsername?: string | null,
category?: string | null,
comment?: string | null,
data?: Record<string, any> | null,
deletedAt?: string | null,
destroyed?: boolean | null,
displayAuthorUsername?: boolean | null,
displayIssueChanges?: boolean | null,
displaySeverity?: boolean | null,
disputeComment?: string | null,
disputeReason?: string | null,
disputeRejectionReason?: string | null,
disputeStatus?: string | null,
draft?: boolean | null,
editorUsername?: string | null,
isReviewed?: boolean | null,
issueLogs?: string[] | null,
order?: number | null,
origin?: string | null,
reviewableAttachmentId?: string | null,
reviewed?: boolean | null,
severity?: number | null,
solved?: boolean | null,
state?: string | null,
updatedAt?: string | null,
x?: string | null,
y?: string | null
},
relationships?: Record<string, any>
}[]
meta full type
meta full type
{
page?: number | null,
per_page?: number | null,
total_pages?: number | null,
total_records?: number | null
}
delete
productAssets.delete
Delete a product asset. This cannot be undone.
Risk: destructive
await corsair.modelry.api.productAssets.delete({});
| Name | Type | Required | Description |
|---|---|---|---|
product_id | string | number | Yes | — |
id | string | number | Yes | — |
void
Products
create
products.create
Create a product (title, SKU, tags, dimensions, links).
Risk: write
await corsair.modelry.api.products.create({});
| Name | Type | Required | Description |
|---|---|---|---|
product | object | Yes | — |
product full type
product full type
{
title?: string,
sku?: string,
description?: string | null,
batch_id?: string | null,
tags?: string[],
dimensions?: string | null,
external_url?: string | null
}
| Name | Type | Required | Description |
|---|---|---|---|
data | object | Yes | — |
included | object[] | No | — |
meta | object | No | — |
data full type
data full type
{
id: string,
type: string,
attributes?: {
uid?: string | null,
sku?: string | null,
title?: string | null,
name?: string | null,
createdAt?: string | null,
batchID?: string | null,
batchId?: string | null,
batchUid?: string | null,
deliveredAt?: string | null,
status?: string | null,
pipeline?: string | null,
price?: string | null,
previewImageUrl?: string | null,
dimensions?: string | null,
productUrl?: string | null,
productId?: number | null,
requestType?: string | null,
inCustomerQa?: boolean | null,
customerQaUrl?: string | null,
currentRoundNumber?: number | null,
currentRoundSaved?: boolean | null,
referenceFileUrls?: string[] | null,
reviewCategories?: {
id: string,
title: string
}[] | null,
description?: string | null,
tags?: string[] | null,
sourceLabel?: string | null,
toolKinds?: string[] | null,
contentLabels?: string[] | null,
byteSize?: number | string | null,
labels?: string[] | null,
url?: string | null,
fileName?: string | null,
kinds?: string[] | null,
published?: boolean | null,
loaderScriptConfiguration?: Record<string, any>[] | null,
adminIssueId?: string | null,
annotation?: Record<string, any> | null,
authorId?: string | null,
authorRole?: string | null,
authorUsername?: string | null,
category?: string | null,
comment?: string | null,
data?: Record<string, any> | null,
deletedAt?: string | null,
destroyed?: boolean | null,
displayAuthorUsername?: boolean | null,
displayIssueChanges?: boolean | null,
displaySeverity?: boolean | null,
disputeComment?: string | null,
disputeReason?: string | null,
disputeRejectionReason?: string | null,
disputeStatus?: string | null,
draft?: boolean | null,
editorUsername?: string | null,
isReviewed?: boolean | null,
issueLogs?: string[] | null,
order?: number | null,
origin?: string | null,
reviewableAttachmentId?: string | null,
reviewed?: boolean | null,
severity?: number | null,
solved?: boolean | null,
state?: string | null,
updatedAt?: string | null,
x?: string | null,
y?: string | null
},
relationships?: Record<string, any>
}
included full type
included full type
{
id: string,
type: string,
attributes?: {
uid?: string | null,
sku?: string | null,
title?: string | null,
name?: string | null,
createdAt?: string | null,
batchID?: string | null,
batchId?: string | null,
batchUid?: string | null,
deliveredAt?: string | null,
status?: string | null,
pipeline?: string | null,
price?: string | null,
previewImageUrl?: string | null,
dimensions?: string | null,
productUrl?: string | null,
productId?: number | null,
requestType?: string | null,
inCustomerQa?: boolean | null,
customerQaUrl?: string | null,
currentRoundNumber?: number | null,
currentRoundSaved?: boolean | null,
referenceFileUrls?: string[] | null,
reviewCategories?: {
id: string,
title: string
}[] | null,
description?: string | null,
tags?: string[] | null,
sourceLabel?: string | null,
toolKinds?: string[] | null,
contentLabels?: string[] | null,
byteSize?: number | string | null,
labels?: string[] | null,
url?: string | null,
fileName?: string | null,
kinds?: string[] | null,
published?: boolean | null,
loaderScriptConfiguration?: Record<string, any>[] | null,
adminIssueId?: string | null,
annotation?: Record<string, any> | null,
authorId?: string | null,
authorRole?: string | null,
authorUsername?: string | null,
category?: string | null,
comment?: string | null,
data?: Record<string, any> | null,
deletedAt?: string | null,
destroyed?: boolean | null,
displayAuthorUsername?: boolean | null,
displayIssueChanges?: boolean | null,
displaySeverity?: boolean | null,
disputeComment?: string | null,
disputeReason?: string | null,
disputeRejectionReason?: string | null,
disputeStatus?: string | null,
draft?: boolean | null,
editorUsername?: string | null,
isReviewed?: boolean | null,
issueLogs?: string[] | null,
order?: number | null,
origin?: string | null,
reviewableAttachmentId?: string | null,
reviewed?: boolean | null,
severity?: number | null,
solved?: boolean | null,
state?: string | null,
updatedAt?: string | null,
x?: string | null,
y?: string | null
},
relationships?: Record<string, any>
}[]
meta full type
meta full type
{
page?: number | null,
per_page?: number | null,
total_pages?: number | null,
total_records?: number | null
}
delete
products.delete
Delete a product. This cannot be undone.
Risk: destructive
await corsair.modelry.api.products.delete({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | number | Yes | — |
void
get
products.get
Get one product, with its assets and modeling requests under included.
Risk: read
await corsair.modelry.api.products.get({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | number | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
data | object | Yes | — |
included | object[] | No | — |
meta | object | No | — |
data full type
data full type
{
id: string,
type: string,
attributes?: {
uid?: string | null,
sku?: string | null,
title?: string | null,
name?: string | null,
createdAt?: string | null,
batchID?: string | null,
batchId?: string | null,
batchUid?: string | null,
deliveredAt?: string | null,
status?: string | null,
pipeline?: string | null,
price?: string | null,
previewImageUrl?: string | null,
dimensions?: string | null,
productUrl?: string | null,
productId?: number | null,
requestType?: string | null,
inCustomerQa?: boolean | null,
customerQaUrl?: string | null,
currentRoundNumber?: number | null,
currentRoundSaved?: boolean | null,
referenceFileUrls?: string[] | null,
reviewCategories?: {
id: string,
title: string
}[] | null,
description?: string | null,
tags?: string[] | null,
sourceLabel?: string | null,
toolKinds?: string[] | null,
contentLabels?: string[] | null,
byteSize?: number | string | null,
labels?: string[] | null,
url?: string | null,
fileName?: string | null,
kinds?: string[] | null,
published?: boolean | null,
loaderScriptConfiguration?: Record<string, any>[] | null,
adminIssueId?: string | null,
annotation?: Record<string, any> | null,
authorId?: string | null,
authorRole?: string | null,
authorUsername?: string | null,
category?: string | null,
comment?: string | null,
data?: Record<string, any> | null,
deletedAt?: string | null,
destroyed?: boolean | null,
displayAuthorUsername?: boolean | null,
displayIssueChanges?: boolean | null,
displaySeverity?: boolean | null,
disputeComment?: string | null,
disputeReason?: string | null,
disputeRejectionReason?: string | null,
disputeStatus?: string | null,
draft?: boolean | null,
editorUsername?: string | null,
isReviewed?: boolean | null,
issueLogs?: string[] | null,
order?: number | null,
origin?: string | null,
reviewableAttachmentId?: string | null,
reviewed?: boolean | null,
severity?: number | null,
solved?: boolean | null,
state?: string | null,
updatedAt?: string | null,
x?: string | null,
y?: string | null
},
relationships?: Record<string, any>
}
included full type
included full type
{
id: string,
type: string,
attributes?: {
uid?: string | null,
sku?: string | null,
title?: string | null,
name?: string | null,
createdAt?: string | null,
batchID?: string | null,
batchId?: string | null,
batchUid?: string | null,
deliveredAt?: string | null,
status?: string | null,
pipeline?: string | null,
price?: string | null,
previewImageUrl?: string | null,
dimensions?: string | null,
productUrl?: string | null,
productId?: number | null,
requestType?: string | null,
inCustomerQa?: boolean | null,
customerQaUrl?: string | null,
currentRoundNumber?: number | null,
currentRoundSaved?: boolean | null,
referenceFileUrls?: string[] | null,
reviewCategories?: {
id: string,
title: string
}[] | null,
description?: string | null,
tags?: string[] | null,
sourceLabel?: string | null,
toolKinds?: string[] | null,
contentLabels?: string[] | null,
byteSize?: number | string | null,
labels?: string[] | null,
url?: string | null,
fileName?: string | null,
kinds?: string[] | null,
published?: boolean | null,
loaderScriptConfiguration?: Record<string, any>[] | null,
adminIssueId?: string | null,
annotation?: Record<string, any> | null,
authorId?: string | null,
authorRole?: string | null,
authorUsername?: string | null,
category?: string | null,
comment?: string | null,
data?: Record<string, any> | null,
deletedAt?: string | null,
destroyed?: boolean | null,
displayAuthorUsername?: boolean | null,
displayIssueChanges?: boolean | null,
displaySeverity?: boolean | null,
disputeComment?: string | null,
disputeReason?: string | null,
disputeRejectionReason?: string | null,
disputeStatus?: string | null,
draft?: boolean | null,
editorUsername?: string | null,
isReviewed?: boolean | null,
issueLogs?: string[] | null,
order?: number | null,
origin?: string | null,
reviewableAttachmentId?: string | null,
reviewed?: boolean | null,
severity?: number | null,
solved?: boolean | null,
state?: string | null,
updatedAt?: string | null,
x?: string | null,
y?: string | null
},
relationships?: Record<string, any>
}[]
meta full type
meta full type
{
page?: number | null,
per_page?: number | null,
total_pages?: number | null,
total_records?: number | null
}
list
products.list
List products in the workspace, with keyword, SKU, batch, tag and label filters. An empty result is returned as an empty list.
Risk: read
await corsair.modelry.api.products.list({});
| Name | Type | Required | Description |
|---|---|---|---|
page | number | No | — |
per_page | number | No | — |
sort_by | string[] | No | — |
keywords | string | No | — |
sku | string | No | — |
batch_id | string | No | — |
title | string | No | — |
tags | string[] | No | — |
source_label | string[] | No | — |
content_labels | string[] | No | — |
tool_kinds | string[] | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
data | object[] | Yes | — |
meta | object | No | — |
data full type
data full type
{
id: string,
type: string,
attributes?: {
uid?: string | null,
sku?: string | null,
title?: string | null,
name?: string | null,
createdAt?: string | null,
batchID?: string | null,
batchId?: string | null,
batchUid?: string | null,
deliveredAt?: string | null,
status?: string | null,
pipeline?: string | null,
price?: string | null,
previewImageUrl?: string | null,
dimensions?: string | null,
productUrl?: string | null,
productId?: number | null,
requestType?: string | null,
inCustomerQa?: boolean | null,
customerQaUrl?: string | null,
currentRoundNumber?: number | null,
currentRoundSaved?: boolean | null,
referenceFileUrls?: string[] | null,
reviewCategories?: {
id: string,
title: string
}[] | null,
description?: string | null,
tags?: string[] | null,
sourceLabel?: string | null,
toolKinds?: string[] | null,
contentLabels?: string[] | null,
byteSize?: number | string | null,
labels?: string[] | null,
url?: string | null,
fileName?: string | null,
kinds?: string[] | null,
published?: boolean | null,
loaderScriptConfiguration?: Record<string, any>[] | null,
adminIssueId?: string | null,
annotation?: Record<string, any> | null,
authorId?: string | null,
authorRole?: string | null,
authorUsername?: string | null,
category?: string | null,
comment?: string | null,
data?: Record<string, any> | null,
deletedAt?: string | null,
destroyed?: boolean | null,
displayAuthorUsername?: boolean | null,
displayIssueChanges?: boolean | null,
displaySeverity?: boolean | null,
disputeComment?: string | null,
disputeReason?: string | null,
disputeRejectionReason?: string | null,
disputeStatus?: string | null,
draft?: boolean | null,
editorUsername?: string | null,
isReviewed?: boolean | null,
issueLogs?: string[] | null,
order?: number | null,
origin?: string | null,
reviewableAttachmentId?: string | null,
reviewed?: boolean | null,
severity?: number | null,
solved?: boolean | null,
state?: string | null,
updatedAt?: string | null,
x?: string | null,
y?: string | null
},
relationships?: Record<string, any>
}[]
meta full type
meta full type
{
page?: number | null,
per_page?: number | null,
total_pages?: number | null,
total_records?: number | null
}
update
products.update
Update the fields of an existing product.
Risk: write
await corsair.modelry.api.products.update({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | number | Yes | — |
product | object | Yes | — |
product full type
product full type
{
title?: string,
sku?: string,
description?: string | null,
batch_id?: string | null,
tags?: string[],
dimensions?: string | null,
external_url?: string | null
}
| Name | Type | Required | Description |
|---|---|---|---|
data | object | Yes | — |
included | object[] | No | — |
meta | object | No | — |
data full type
data full type
{
id: string,
type: string,
attributes?: {
uid?: string | null,
sku?: string | null,
title?: string | null,
name?: string | null,
createdAt?: string | null,
batchID?: string | null,
batchId?: string | null,
batchUid?: string | null,
deliveredAt?: string | null,
status?: string | null,
pipeline?: string | null,
price?: string | null,
previewImageUrl?: string | null,
dimensions?: string | null,
productUrl?: string | null,
productId?: number | null,
requestType?: string | null,
inCustomerQa?: boolean | null,
customerQaUrl?: string | null,
currentRoundNumber?: number | null,
currentRoundSaved?: boolean | null,
referenceFileUrls?: string[] | null,
reviewCategories?: {
id: string,
title: string
}[] | null,
description?: string | null,
tags?: string[] | null,
sourceLabel?: string | null,
toolKinds?: string[] | null,
contentLabels?: string[] | null,
byteSize?: number | string | null,
labels?: string[] | null,
url?: string | null,
fileName?: string | null,
kinds?: string[] | null,
published?: boolean | null,
loaderScriptConfiguration?: Record<string, any>[] | null,
adminIssueId?: string | null,
annotation?: Record<string, any> | null,
authorId?: string | null,
authorRole?: string | null,
authorUsername?: string | null,
category?: string | null,
comment?: string | null,
data?: Record<string, any> | null,
deletedAt?: string | null,
destroyed?: boolean | null,
displayAuthorUsername?: boolean | null,
displayIssueChanges?: boolean | null,
displaySeverity?: boolean | null,
disputeComment?: string | null,
disputeReason?: string | null,
disputeRejectionReason?: string | null,
disputeStatus?: string | null,
draft?: boolean | null,
editorUsername?: string | null,
isReviewed?: boolean | null,
issueLogs?: string[] | null,
order?: number | null,
origin?: string | null,
reviewableAttachmentId?: string | null,
reviewed?: boolean | null,
severity?: number | null,
solved?: boolean | null,
state?: string | null,
updatedAt?: string | null,
x?: string | null,
y?: string | null
},
relationships?: Record<string, any>
}
included full type
included full type
{
id: string,
type: string,
attributes?: {
uid?: string | null,
sku?: string | null,
title?: string | null,
name?: string | null,
createdAt?: string | null,
batchID?: string | null,
batchId?: string | null,
batchUid?: string | null,
deliveredAt?: string | null,
status?: string | null,
pipeline?: string | null,
price?: string | null,
previewImageUrl?: string | null,
dimensions?: string | null,
productUrl?: string | null,
productId?: number | null,
requestType?: string | null,
inCustomerQa?: boolean | null,
customerQaUrl?: string | null,
currentRoundNumber?: number | null,
currentRoundSaved?: boolean | null,
referenceFileUrls?: string[] | null,
reviewCategories?: {
id: string,
title: string
}[] | null,
description?: string | null,
tags?: string[] | null,
sourceLabel?: string | null,
toolKinds?: string[] | null,
contentLabels?: string[] | null,
byteSize?: number | string | null,
labels?: string[] | null,
url?: string | null,
fileName?: string | null,
kinds?: string[] | null,
published?: boolean | null,
loaderScriptConfiguration?: Record<string, any>[] | null,
adminIssueId?: string | null,
annotation?: Record<string, any> | null,
authorId?: string | null,
authorRole?: string | null,
authorUsername?: string | null,
category?: string | null,
comment?: string | null,
data?: Record<string, any> | null,
deletedAt?: string | null,
destroyed?: boolean | null,
displayAuthorUsername?: boolean | null,
displayIssueChanges?: boolean | null,
displaySeverity?: boolean | null,
disputeComment?: string | null,
disputeReason?: string | null,
disputeRejectionReason?: string | null,
disputeStatus?: string | null,
draft?: boolean | null,
editorUsername?: string | null,
isReviewed?: boolean | null,
issueLogs?: string[] | null,
order?: number | null,
origin?: string | null,
reviewableAttachmentId?: string | null,
reviewed?: boolean | null,
severity?: number | null,
solved?: boolean | null,
state?: string | null,
updatedAt?: string | null,
x?: string | null,
y?: string | null
},
relationships?: Record<string, any>
}[]
meta full type
meta full type
{
page?: number | null,
per_page?: number | null,
total_pages?: number | null,
total_records?: number | null
}
Reviews
create
reviews.create
Add review issues (comments for Modelry’s artists) to a modeling request’s current QA round.
Risk: write
await corsair.modelry.api.reviews.create({});
| Name | Type | Required | Description |
|---|---|---|---|
modeling_request_id_or_sku | string | number | Yes | — |
review_issues | object[] | Yes | — |
review_issues full type
review_issues full type
{
filename: string,
category: string,
comment: string,
severity?: number | string,
order?: number | string,
data?: Record<string, any>,
annotation?: Record<string, any>,
reviewed?: boolean,
issue_image?: string,
x?: string,
y?: string
}[]
| Name | Type | Required | Description |
|---|---|---|---|
data | object | object[] | Yes | — |
data full type
data full type
{
id: string,
type: string,
attributes?: {
uid?: string | null,
sku?: string | null,
title?: string | null,
name?: string | null,
createdAt?: string | null,
batchID?: string | null,
batchId?: string | null,
batchUid?: string | null,
deliveredAt?: string | null,
status?: string | null,
pipeline?: string | null,
price?: string | null,
previewImageUrl?: string | null,
dimensions?: string | null,
productUrl?: string | null,
productId?: number | null,
requestType?: string | null,
inCustomerQa?: boolean | null,
customerQaUrl?: string | null,
currentRoundNumber?: number | null,
currentRoundSaved?: boolean | null,
referenceFileUrls?: string[] | null,
reviewCategories?: {
id: string,
title: string
}[] | null,
description?: string | null,
tags?: string[] | null,
sourceLabel?: string | null,
toolKinds?: string[] | null,
contentLabels?: string[] | null,
byteSize?: number | string | null,
labels?: string[] | null,
url?: string | null,
fileName?: string | null,
kinds?: string[] | null,
published?: boolean | null,
loaderScriptConfiguration?: Record<string, any>[] | null,
adminIssueId?: string | null,
annotation?: Record<string, any> | null,
authorId?: string | null,
authorRole?: string | null,
authorUsername?: string | null,
category?: string | null,
comment?: string | null,
data?: Record<string, any> | null,
deletedAt?: string | null,
destroyed?: boolean | null,
displayAuthorUsername?: boolean | null,
displayIssueChanges?: boolean | null,
displaySeverity?: boolean | null,
disputeComment?: string | null,
disputeReason?: string | null,
disputeRejectionReason?: string | null,
disputeStatus?: string | null,
draft?: boolean | null,
editorUsername?: string | null,
isReviewed?: boolean | null,
issueLogs?: string[] | null,
order?: number | null,
origin?: string | null,
reviewableAttachmentId?: string | null,
reviewed?: boolean | null,
severity?: number | null,
solved?: boolean | null,
state?: string | null,
updatedAt?: string | null,
x?: string | null,
y?: string | null
},
relationships?: Record<string, any>
} | {
id: string,
type: string,
attributes?: {
uid?: string | null,
sku?: string | null,
title?: string | null,
name?: string | null,
createdAt?: string | null,
batchID?: string | null,
batchId?: string | null,
batchUid?: string | null,
deliveredAt?: string | null,
status?: string | null,
pipeline?: string | null,
price?: string | null,
previewImageUrl?: string | null,
dimensions?: string | null,
productUrl?: string | null,
productId?: number | null,
requestType?: string | null,
inCustomerQa?: boolean | null,
customerQaUrl?: string | null,
currentRoundNumber?: number | null,
currentRoundSaved?: boolean | null,
referenceFileUrls?: string[] | null,
reviewCategories?: {
id: string,
title: string
}[] | null,
description?: string | null,
tags?: string[] | null,
sourceLabel?: string | null,
toolKinds?: string[] | null,
contentLabels?: string[] | null,
byteSize?: number | string | null,
labels?: string[] | null,
url?: string | null,
fileName?: string | null,
kinds?: string[] | null,
published?: boolean | null,
loaderScriptConfiguration?: Record<string, any>[] | null,
adminIssueId?: string | null,
annotation?: Record<string, any> | null,
authorId?: string | null,
authorRole?: string | null,
authorUsername?: string | null,
category?: string | null,
comment?: string | null,
data?: Record<string, any> | null,
deletedAt?: string | null,
destroyed?: boolean | null,
displayAuthorUsername?: boolean | null,
displayIssueChanges?: boolean | null,
displaySeverity?: boolean | null,
disputeComment?: string | null,
disputeReason?: string | null,
disputeRejectionReason?: string | null,
disputeStatus?: string | null,
draft?: boolean | null,
editorUsername?: string | null,
isReviewed?: boolean | null,
issueLogs?: string[] | null,
order?: number | null,
origin?: string | null,
reviewableAttachmentId?: string | null,
reviewed?: boolean | null,
severity?: number | null,
solved?: boolean | null,
state?: string | null,
updatedAt?: string | null,
x?: string | null,
y?: string | null
},
relationships?: Record<string, any>
}[]
Uploads
blob
uploads.blob
Start a direct upload: returns a signed blob id and a presigned URL to PUT the file to.
Risk: write
await corsair.modelry.api.uploads.blob({});
| Name | Type | Required | Description |
|---|---|---|---|
blob | object | Yes | — |
blob full type
blob full type
{
filename: string,
byte_size: number,
checksum: string,
content_type: string
}
| Name | Type | Required | Description |
|---|---|---|---|
signed_id | string | Yes | — |
service_url | string | Yes | — |
headers | Record<string, string> | Yes | — |
file
uploads.file
Upload a small file as base64 and get back its signed blob id.
Risk: write
await corsair.modelry.api.uploads.file({});
| Name | Type | Required | Description |
|---|---|---|---|
filename | string | Yes | — |
base64_file | string | Yes | — |
content_type | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
blob_id | number | Yes | — |
signed_blob_id | string | Yes | — |
url | string | Yes | — |
Workspaces
list
workspaces.list
List the workspaces the API token can access.
Risk: read
await corsair.modelry.api.workspaces.list({});
| Name | Type | Required | Description |
|---|---|---|---|
page | number | No | — |
per_page | number | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
data | object[] | Yes | — |
meta | object | No | — |
data full type
data full type
{
id: string,
type: string,
attributes?: {
uid?: string | null,
sku?: string | null,
title?: string | null,
name?: string | null,
createdAt?: string | null,
batchID?: string | null,
batchId?: string | null,
batchUid?: string | null,
deliveredAt?: string | null,
status?: string | null,
pipeline?: string | null,
price?: string | null,
previewImageUrl?: string | null,
dimensions?: string | null,
productUrl?: string | null,
productId?: number | null,
requestType?: string | null,
inCustomerQa?: boolean | null,
customerQaUrl?: string | null,
currentRoundNumber?: number | null,
currentRoundSaved?: boolean | null,
referenceFileUrls?: string[] | null,
reviewCategories?: {
id: string,
title: string
}[] | null,
description?: string | null,
tags?: string[] | null,
sourceLabel?: string | null,
toolKinds?: string[] | null,
contentLabels?: string[] | null,
byteSize?: number | string | null,
labels?: string[] | null,
url?: string | null,
fileName?: string | null,
kinds?: string[] | null,
published?: boolean | null,
loaderScriptConfiguration?: Record<string, any>[] | null,
adminIssueId?: string | null,
annotation?: Record<string, any> | null,
authorId?: string | null,
authorRole?: string | null,
authorUsername?: string | null,
category?: string | null,
comment?: string | null,
data?: Record<string, any> | null,
deletedAt?: string | null,
destroyed?: boolean | null,
displayAuthorUsername?: boolean | null,
displayIssueChanges?: boolean | null,
displaySeverity?: boolean | null,
disputeComment?: string | null,
disputeReason?: string | null,
disputeRejectionReason?: string | null,
disputeStatus?: string | null,
draft?: boolean | null,
editorUsername?: string | null,
isReviewed?: boolean | null,
issueLogs?: string[] | null,
order?: number | null,
origin?: string | null,
reviewableAttachmentId?: string | null,
reviewed?: boolean | null,
severity?: number | null,
solved?: boolean | null,
state?: string | null,
updatedAt?: string | null,
x?: string | null,
y?: string | null
},
relationships?: Record<string, any>
}[]
meta full type
meta full type
{
page?: number | null,
per_page?: number | null,
total_pages?: number | null,
total_records?: number | null
}