Land of Assets API (0.0.1)

Download OpenAPI specification:Download

API Support: [email protected] URL: https://github.com/landofassets License: Apache 2.0

Land of Assets API Reference

Auth

OAuth consent

OAuth 2.0 consent endpoint - creates authorization code

Authorizations:

frontendToken

Request Body schema: application/json
required

client_id required	string
redirect_uri required	string <uri>
response_type required	string Value: "code"
scope required	string
state required	string
code_challenge required	string
code_challenge_method required	string Value: "S256"
action required	string Enum: "APPROVE" "DENY"
session_token required	string

Responses

Request samples

Payload

Content type

application/json

{"client_id": "string",
"redirect_uri": "http://example.com",
"response_type": "code",
"scope": "string",
"state": "string",
"code_challenge": "string",
"code_challenge_method": "S256",
"action": "APPROVE",
"session_token": "string"
}

Response samples

302
400
401
429

Content type

application/json

{"redirectUrl": "string"
}

OAuth authorize

OAuth 2.0 authorization endpoint

Authorizations:

anonymous

query Parameters

client_id required	string
redirect_uri required	string <uri>
response_type required	string Value: "code"
scope	string
state required	string
code_challenge required	string
code_challenge_method required	string Value: "S256"

Responses

Response samples

302
400
401
429

Content type

application/json

{"redirectUrl": "string"
}

Refresh access token

Refresh access token using session token

Authorizations:

sessionTokensecretToken

Request Body schema: application/json
required

refreshToken

required

string

The refresh token to use for refreshing the access token (must start with "ut_" for session tokens or "st_" for API tokens)

Responses

Request samples

Payload

Content type

application/json

{"refreshToken": "string"
}

Response samples

200
201
400
401

Content type

application/json

{"accessToken": "string"
}

OAuth token

OAuth 2.0 token endpoint - exchange authorization code for tokens

Authorizations:

anonymous

Request Body schema: application/json
required

grant_type required	string Value: "authorization_code"
code required	string
client_id required	string
code_verifier required	string
redirect_uri required	string <uri>
client_secret	string

Responses

Request samples

Payload

Content type

application/json

{"grant_type": "authorization_code",
"code": "string",
"client_id": "string",
"code_verifier": "string",
"redirect_uri": "http://example.com",
"client_secret": "string"
}

Response samples

200
400
401
429

Content type

application/json

{"access_token": "string",
"refresh_token": "string",
"token_type": "Bearer",
"expires_in": 0
}

Request login code

Request login code (OTP) to be sent via email

Authorizations:

anonymous

Request Body schema: application/json
required

emailOrUsername required	string non-empty
redirectTo	string

Responses

Request samples

Payload

Content type

application/json

{"emailOrUsername": "string",
"redirectTo": "string"
}

Response samples

200
400
409
429

Content type

application/json

{"codeVerificationToken": "string"
}

Verify login code

Verify login code (OTP) and authenticate user

Authorizations:

anonymous

Request Body schema: application/json
required

codeVerificationToken required	string
otpCode required	string = 8 characters ^[A-Za-z0-9]+$

Responses

Request samples

Payload

Content type

application/json

{"codeVerificationToken": "string",
"otpCode": "stringst"
}

Response samples

200
400
401
429

Content type

application/json

{"userSessionToken": "string",
"accessToken": "string"
}

Delete refresh token

Delete a refresh token (session) by invalidating it

Authorizations:

sessionTokensecretToken

path Parameters

token

required

string

The refresh token to delete

Responses

Response samples

204
400
401
403
404

Content type

application/json

{ }

Complete signup

Complete signup by creating user with username and legal agreement acceptance

Authorizations:

anonymous

Request Body schema: application/json
required

userRequestId required	integer [ -9007199254740991 .. 9007199254740991 ]
userName required	string [ 1 .. 50 ] characters ^[a-zA-Z0-9_-]+$
legalAgreementAccepted required	boolean

Responses

Request samples

Payload

Content type

application/json

{"userRequestId": -9007199254740991,
"userName": "string",
"legalAgreementAccepted": true
}

Response samples

200
400
403
404
429

Content type

application/json

{"userSessionToken": "string",
"accessToken": "string"
}

Initiate signup

Initiate email-based signup flow by creating a signup request and sending verification code

Authorizations:

anonymous

Request Body schema: application/json
required

email required	string <email> ^(?:[A-Za-z0-9_'+\-]+\.)[A-Za-z0-9_'+\-][A-...
redirectTo	string

Responses

Request samples

Payload

Content type

application/json

{"email": "[email protected]",
"redirectTo": "string"
}

Response samples

200
400
409
429

Content type

application/json

{"codeVerificationToken": "string"
}

Verify signup email

Verify email code during signup flow

Authorizations:

anonymous

Request Body schema: application/json
required

codeVerificationToken required	string
otpCode required	string = 8 characters ^[A-Za-z0-9]+$

Responses

Request samples

Payload

Content type

application/json

{"codeVerificationToken": "string",
"otpCode": "stringst"
}

Response samples

200
400
401
429

Content type

application/json

{"userRequestId": -9007199254740991,
"email": "[email protected]"
}

Handle Google OAuth callback

Handle Google OAuth callback and authenticate user or create signup request

Authorizations:

anonymous

Request Body schema: application/json
required

code required	string
state required	string
flow required	string Enum: "signup" "login"
redirectTo	string

Responses

Request samples

Payload

Content type

application/json

{"code": "string",
"state": "string",
"flow": "signup",
"redirectTo": "string"
}

Response samples

200
400
401

Content type

application/json

{"type": "login",
"userSessionToken": "string",
"accessToken": "string",
"userRequestId": -9007199254740991,
"email": "[email protected]",
"fullName": "string",
"redirectTo": "string"
}

Initiate Google OAuth

Initiate Google OAuth flow for signup or login

Authorizations:

anonymous

Request Body schema: application/json
required

flow required	string Enum: "signup" "login"
redirectTo	string

Responses

Request samples

Payload

Content type

application/json

{"flow": "signup",
"redirectTo": "string"
}

Response samples

200
400

Content type

application/json

{"authorizationUrl": "http://example.com",
"state": "string"
}

Generate passkey authentication options

Generate passkey authentication options for discovery mode (no user identification required)

Authorizations:

anonymous

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200
400

Content type

application/json

{"options": {"property1": null,
"property2": null
},
"authenticationToken": "string"
}

Verify passkey authentication

Verify passkey authentication and authenticate user

Authorizations:

anonymous

Request Body schema: application/json
required

authenticationToken required	string
required	object

Responses

Request samples

Payload

Content type

application/json

{"authenticationToken": "string",
"authenticationResponse": {"id": "string",
"rawId": "string",
"response": {"clientDataJSON": "string",
"authenticatorData": "string",
"signature": "string",
"userHandle": "string"
},
"type": "public-key",
"clientExtensionResults": {"property1": null,
"property2": null
}
}
}

Response samples

200
400
401
429

Content type

application/json

{"userSessionToken": "string",
"accessToken": "string"
}

Users

List users

List users. Only super users can list users.

Authorizations:

jwtTokensecretToken

query Parameters

pageOffset	integer [ 0 .. 9007199254740991 ] The number of items to skip before starting to return results. Must be 0 or greater.
pageSize	integer [ 1 .. 1000 ] The maximum number of items to return. Must be between 1 and 1000.
sortBy	string Enum: "createdAt" "email" "name" "fullName" The field to sort by
sortDir	string Enum: "asc" "desc" The direction to sort by
searchText	string <= 256 characters

Responses

Response samples

200
400
401
403

Content type

application/json

{"rows": [{"id": -9007199254740991,
"name": "string"
}
],
"rowCount": 0
}

Delete user

Delete a user account. Users cannot be deleted if they are admins of organizations or projects. The user is permanently deleted.

Authorizations:

jwtTokensecretToken

path Parameters

userName

required

string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9]*(?:-[a-zA-Z0-9]+)*$

The name of the user

Responses

Response samples

204
400
401
403
404

Content type

application/json

{ }

Get user

Get user details by username.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

userName

required

string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9]*(?:-[a-zA-Z0-9]+)*$

The name of the user

Responses

Response samples

200
400
401
403
404

Content type

application/json

{"id": -9007199254740991,
"name": "string"
}

Update user

Update user profile including name, full name, location, role, contact information, and email notification preferences.

Authorizations:

jwtTokensecretToken

path Parameters

userName

required

string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9]*(?:-[a-zA-Z0-9]+)*$

The name of the user

Request Body schema: application/json

name	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the user
fullName	string <= 255 characters
	string or null
city	string <= 100 characters
role	string <= 255 characters
company	string <= 255 characters
phoneNumber	string <= 50 characters
emailNotifications	boolean
emailNewsletterUpdates	boolean
emailAssetLikeNotifications	boolean
emailCommentLikeNotifications	boolean

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"fullName": "string",
"country": "~",
"city": "string",
"role": "string",
"company": "string",
"phoneNumber": "string",
"emailNotifications": true,
"emailNewsletterUpdates": true,
"emailAssetLikeNotifications": true,
"emailCommentLikeNotifications": true
}

Response samples

200
400
401
403
404

Content type

application/json

{"id": -9007199254740991,
"name": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"email": "string",
"fullName": "string",
"country": "~",
"company": "string",
"city": "string",
"role": "string",
"phoneNumber": "string",
"type": "STANDARD",
"personalOrgId": -9007199254740991,
"emailNotifications": true,
"emailNewsletterUpdates": true,
"emailAssetLikeNotifications": true,
"emailCommentLikeNotifications": true
}

Get private user

Get private user details by username. Users can only view their own private details unless they are super users.

Authorizations:

jwtTokensecretToken

path Parameters

userName

required

string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9]*(?:-[a-zA-Z0-9]+)*$

The name of the user

Responses

Response samples

200
400
401
403
404

Content type

application/json

{"id": -9007199254740991,
"name": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"email": "string",
"fullName": "string",
"country": "~",
"company": "string",
"city": "string",
"role": "string",
"phoneNumber": "string",
"type": "STANDARD",
"personalOrgId": -9007199254740991,
"emailNotifications": true,
"emailNewsletterUpdates": true,
"emailAssetLikeNotifications": true,
"emailCommentLikeNotifications": true
}

End user session

End a user session by marking it as deleted. Users can only end their own sessions.

Authorizations:

jwtTokensecretToken

path Parameters

userName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the user
sessionId required	integer [ -9007199254740991 .. 9007199254740991 ]

Responses

Response samples

204
401
403
404

Content type

application/json

{ }

List user sessions

List active user sessions for a user with pagination and sorting. Only returns sessions that are not deleted and not expired.

Authorizations:

jwtTokensecretToken

path Parameters

userName

required

string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9]*(?:-[a-zA-Z0-9]+)*$

The name of the user

query Parameters

pageOffset	integer [ 0 .. 9007199254740991 ] The number of items to skip before starting to return results. Must be 0 or greater.
pageSize	integer [ 1 .. 1000 ] The maximum number of items to return. Must be between 1 and 1000.
sortBy	string Enum: "createdAt" "lastUsedAt" "expiresAt" "ipAddress" The field to sort by
sortDir	string Enum: "asc" "desc" The direction to sort by

Responses

Response samples

200
400
401
403
404

Content type

application/json

{"rows": [{"id": -9007199254740991,
"ipAddress": "string",
"browser": null,
"os": null,
"client": null,
"createdAt": "2019-08-24T14:15:22Z",
"lastUsedAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z"
}
],
"rowCount": 0
}

Orgs

List organizations

List organizations, optionally filtered by visibility or username. Unauthenticated users can only see public organizations.

Authorizations:

jwtTokensecretTokenNone

query Parameters

pageOffset	integer [ 0 .. 9007199254740991 ] The number of items to skip before starting to return results. Must be 0 or greater.
pageSize	integer [ 1 .. 1000 ] The maximum number of items to return. Must be between 1 and 1000.
sortBy	string Enum: "createdAt" "updatedAt" "name" The field to sort by
sortDir	string Enum: "asc" "desc" The direction to sort by
userName	string <= 100 characters Filter by username
visibility	string Enum: "PRIVATE" "PUBLIC" Filter by visibility (PUBLIC or PRIVATE)

Responses

Response samples

200
400
401
403

Content type

application/json

{"rows": [{"id": -9007199254740991,
"name": "string",
"description": "string",
"visibility": "PRIVATE",
"location": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"isPersonalOrg": true,
"socialLinks": [ ]
}
],
"rowCount": 0
}

Create organization

Create a new organization. The authenticated user becomes an admin member of the created organization.

Authorizations:

jwtTokensecretToken

Request Body schema: application/json
required

name required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
description	string <= 10240 characters Optional description of the organization
visibility required	string Enum: "PRIVATE" "PUBLIC" Visibility level: PUBLIC (anyone can view) or PRIVATE (members only)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"visibility": "PRIVATE"
}

Response samples

201
400
401
403
404

Content type

application/json

{"id": -9007199254740991,
"name": "string",
"description": "string",
"visibility": "PRIVATE",
"location": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"isPersonalOrg": true,
"socialLinks": [ ]
}

Delete organization

Delete an organization. The organization must not have any projects.

Authorizations:

jwtTokensecretToken

path Parameters

orgName

required

string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9]*(?:-[a-zA-Z0-9]+)*$

The name of the organization

Responses

Response samples

204
400
401
403
404

Content type

application/json

{ }

Get organization

Get organization details by organization name.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName

required

string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9]*(?:-[a-zA-Z0-9]+)*$

The name of the organization

Responses

Response samples

200
400
401
403
404

Content type

application/json

{"id": -9007199254740991,
"name": "string",
"description": "string",
"visibility": "PRIVATE",
"location": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"isPersonalOrg": true,
"socialLinks": [ ]
}

Update organization

Update organization profile and settings including name, description, location, and visibility.

Authorizations:

jwtTokensecretToken

path Parameters

orgName

required

string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9]*(?:-[a-zA-Z0-9]+)*$

The name of the organization

Request Body schema: application/json

name	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The new name for the organization
description	string <= 10240 characters The new description for the organization
location	string <= 256 characters The location of the organization
visibility	string Enum: "PRIVATE" "PUBLIC" The new visibility level (PUBLIC or PRIVATE)
	Array of objects Social media links for the organization

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"location": "string",
"visibility": "PRIVATE",
"socialLinks": [{"type": "BLUESKY",
"url": "http://example.com"
}
]
}

Response samples

200
400
401
403
404

Content type

application/json

{"id": -9007199254740991,
"name": "string",
"description": "string",
"visibility": "PRIVATE",
"location": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"isPersonalOrg": true,
"socialLinks": [ ]
}

Projects

List projects

List projects, optionally filtered by organization, user, or visibility. Unauthenticated users can only see public projects.

Authorizations:

jwtTokensecretTokenNone

query Parameters

pageOffset	integer [ 0 .. 9007199254740991 ] The number of items to skip before starting to return results. Must be 0 or greater.
pageSize	integer [ 1 .. 1000 ] The maximum number of items to return. Must be between 1 and 1000.
sortBy	string Enum: "createdAt" "updatedAt" "name" The field to sort by
sortDir	string Enum: "asc" "desc" The direction to sort by
visibility	string Enum: "PRIVATE" "PUBLIC" Filter by visibility (PUBLIC or PRIVATE)
userName	string <= 100 characters Filter by username
orgName	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ Filter by organization name

Responses

Response samples

200
400
401
403
404

Content type

application/json

{"rows": [{"id": -9007199254740991,
"name": "string",
"description": "string",
"visibility": "PRIVATE",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"orgId": -9007199254740991,
"orgName": "string"
}
],
"rowCount": 0
}

Create project

Create a new project in the specified organization.

Authorizations:

jwtTokensecretToken

path Parameters

orgName

required

string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9]*(?:-[a-zA-Z0-9]+)*$

The name of the organization

Request Body schema: application/json
required

name required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
description	string <= 10240 characters Optional description of the project
visibility required	string Enum: "PRIVATE" "PUBLIC" Visibility level: PUBLIC (anyone can view) or PRIVATE (members only)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"visibility": "PRIVATE"
}

Response samples

Content type

application/json

{"id": -9007199254740991,
"name": "string",
"description": "string",
"visibility": "PRIVATE",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"orgId": -9007199254740991,
"orgName": "string"
}

Delete project

Delete a project. The project must not have any assets.

Authorizations:

jwtTokensecretToken

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project

Responses

Response samples

204
400
401
403
404

Content type

application/json

{ }

Get project

Get project details by organization and project name.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project

Responses

Response samples

200
400
401
403
404

Content type

application/json

{"id": -9007199254740991,
"name": "string",
"description": "string",
"visibility": "PRIVATE",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"orgId": -9007199254740991,
"orgName": "string"
}

Update project

Update project metadata including name, description, and visibility. Can also transfer projects between organizations.

Authorizations:

jwtTokensecretToken

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project

Request Body schema: application/json

name	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The new name for the project
description	string <= 10240 characters The new description for the project
visibility	string Enum: "PRIVATE" "PUBLIC" The new visibility level (PUBLIC or PRIVATE)
orgName	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The new organization name (for moving projects)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"visibility": "PRIVATE",
"orgName": "string"
}

Response samples

Content type

application/json

{"id": -9007199254740991,
"name": "string",
"description": "string",
"visibility": "PRIVATE",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"orgId": -9007199254740991,
"orgName": "string"
}

Assets

List assets

List assets, optionally filtered by organization, project, user, visibility, or search text. Unauthenticated users can only see public assets.

Authorizations:

jwtTokensecretTokenNone

query Parameters

pageOffset	integer [ 0 .. 9007199254740991 ] The number of items to skip before starting to return results. Must be 0 or greater.
pageSize	integer [ 1 .. 1000 ] The maximum number of items to return. Must be between 1 and 1000.
sortBy	string Enum: "createdAt" "updatedAt" "name" "likeCount" "shareCount" The field to sort by
sortDir	string Enum: "asc" "desc" The direction to sort by
visibility	string Enum: "PRIVATE" "UNLISTED" "PUBLIC" Filter by visibility (PUBLIC or PRIVATE)
searchText	string <= 256 characters Search text to filter assets by name or description
type	string Enum: "MODEL" "MATERIAL" "IMAGE" "SCENE" "ENVMAP" "CAD" "LIGHT" Filter by asset type
userName	string <= 100 characters Filter by username
orgName	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ Filter by organization name
projectName	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ Filter by project name
archived	boolean Filter by archived status (true for archived, false for non-archived)

Responses

Response samples

200
400
401
403
404

Content type

application/json

{"rows": [{"id": -9007199254740991,
"name": "string",
"type": "MODEL",
"visibility": "PRIVATE",
"projectId": -9007199254740991,
"projectName": "string",
"orgId": -9007199254740991,
"orgName": "string",
"description": "string",
"keywords": "string",
"shareLicense": "NONE",
"aiUsage": "UNDISCLOSED",
"commentMode": "ENABLED",
"reported": true,
"likeCount": -9007199254740991,
"shareCount": -9007199254740991,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"archived": true,
"metadata": "string",
"originalSize": -9007199254740991,
"width": null,
"height": null,
"depth": null,
"version": "string",
"latestVersion": "string",
"versionId": -9007199254740991,
"originalExtension": "string",
"fileOid": "string",
"thumbnailOid": null,
"analysis": {"schemaVersion": 1,
"sourceFileOid": "stringstringstringstringstringstringstringstringstringstringstri",
"analyzerId": "string",
"analyzerVersion": "string",
"status": "pending",
"analyzedAt": "2019-08-24T14:15:22Z",
"data": {"kind": "model",
"dimensions": {"widthMeters": 0,
"depthMeters": 0,
"heightMeters": 0,
"unitSource": "format-defined",
"measurementBasis": "string"
},
"meshCount": 0,
"geometryCount": 0,
"triangleCount": 0,
"vertexCount": 0,
"materialCount": 0,
"textureCount": 0,
"textures": [{"id": "string",
"path": "string",
"widthPixels": 0,
"heightPixels": 0,
"format": "string",
"mimeType": "string",
"byteSize": 0,
"mipLevelCount": 0,
"colorSpace": "string",
"usages": ["string"
]
}
]
},
"validation": {"status": "valid",
"validator": "string",
"validatorVersion": "string",
"rules": ["string"
],
"issues": [{"code": "string",
"severity": "error",
"message": "string",
"location": "string"
}
]
},
"diagnostics": [{"code": "string",
"severity": "error",
"message": "string",
"location": "string"
}
]
},
"analysisSummary": {"schemaVersion": 1,
"sourceFileOid": "stringstringstringstringstringstringstringstringstringstringstri",
"analyzerId": "string",
"analyzerVersion": "string",
"status": "pending",
"analyzedAt": "2019-08-24T14:15:22Z",
"validationStatus": "valid",
"errorCount": 0,
"warningCount": 0,
"data": {"kind": "model",
"dimensions": {"widthMeters": 0,
"depthMeters": 0,
"heightMeters": 0,
"unitSource": "format-defined",
"measurementBasis": "string"
},
"meshCount": 0,
"geometryCount": 0,
"triangleCount": 0,
"vertexCount": 0,
"materialCount": 0,
"textureCount": 0
}
},
"materialInfo": {"version": "string",
"colorspace": "string",
"materials": [{"name": "string",
"category": "string"
}
],
"nodeGraphCount": -9007199254740991,
"topLevelNodeCount": -9007199254740991,
"referencedTextures": ["string"
],
"warnings": ["string"
]
},
"lightInfo": {"version": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"photometricType": 1,
"photometricTypeName": "A",
"photometry": "absolute",
"manufacturer": "string",
"luminaire": "string",
"lightSource": "string",
"lampCatalog": "string",
"lampCount": -9007199254740991,
"lumensPerLamp": 0,
"inputWatts": 0,
"peakCandela": 0,
"verticalAngles": -9007199254740991,
"horizontalAngles": -9007199254740991,
"units": "feet",
"dimensions": {"width": 0,
"length": 0,
"height": 0
},
"hasTilt": true,
"warnings": ["string"
]
}
}
],
"rowCount": 0
}

Create asset

Create a new asset in a project. Requires a prepared upload via the prepare-upload endpoint.

Authorizations:

jwtTokensecretToken

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project

Request Body schema: application/json
required

version	string^(0\|[1-9][0-9])\.(0\|[1-9][0-9])\.(0\|[1-9][0...
name required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset
description	string <= 10240 characters Optional description of the asset
type required	string Enum: "MODEL" "MATERIAL" "IMAGE" "SCENE" "ENVMAP" "CAD" "LIGHT" The type of asset
uploadToken required	string The upload token from prepareAssetUpload
visibility required	string Enum: "PRIVATE" "UNLISTED" "PUBLIC" Visibility level: PUBLIC (anyone can view) or PRIVATE (members only)
shareLicense required	string Enum: "NONE" "CC_0" "CC_BY" "CC_BY_SA" "CC_BY_NC" "CC_BY_NC_SA" "CC_BY_ND" "CC_BY_NC_ND" The license for sharing the asset
aiUsage	string Enum: "UNDISCLOSED" "AI_USED" "AI_FREE" Optional AI usage policy
commentMode	string Enum: "ENABLED" "MEMBERS_ONLY" "NONE" Comment mode: ENABLED (default), MEMBERS_ONLY, or NONE
metadata	string <= 10240 characters Optional metadata as a string (max 10240 characters)

Responses

Request samples

Payload

Content type

application/json

{"version": "string",
"name": "string",
"description": "string",
"type": "MODEL",
"uploadToken": "string",
"visibility": "PRIVATE",
"shareLicense": "NONE",
"aiUsage": "UNDISCLOSED",
"commentMode": "ENABLED",
"metadata": "string"
}

Response samples

Content type

application/json

{"id": -9007199254740991,
"name": "string",
"type": "MODEL",
"visibility": "PRIVATE",
"projectId": -9007199254740991,
"projectName": "string",
"orgId": -9007199254740991,
"orgName": "string",
"description": "string",
"keywords": "string",
"shareLicense": "NONE",
"aiUsage": "UNDISCLOSED",
"commentMode": "ENABLED",
"reported": true,
"likeCount": -9007199254740991,
"shareCount": -9007199254740991,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"archived": true,
"metadata": "string",
"originalSize": -9007199254740991,
"width": null,
"height": null,
"depth": null,
"version": "string",
"latestVersion": "string",
"versionId": -9007199254740991,
"originalExtension": "string",
"fileOid": "string",
"thumbnailOid": null,
"analysis": {"schemaVersion": 1,
"sourceFileOid": "stringstringstringstringstringstringstringstringstringstringstri",
"analyzerId": "string",
"analyzerVersion": "string",
"status": "pending",
"analyzedAt": "2019-08-24T14:15:22Z",
"data": {"kind": "model",
"dimensions": {"widthMeters": 0,
"depthMeters": 0,
"heightMeters": 0,
"unitSource": "format-defined",
"measurementBasis": "string"
},
"meshCount": 0,
"geometryCount": 0,
"triangleCount": 0,
"vertexCount": 0,
"materialCount": 0,
"textureCount": 0,
"textures": [{"id": "string",
"path": "string",
"widthPixels": 0,
"heightPixels": 0,
"format": "string",
"mimeType": "string",
"byteSize": 0,
"mipLevelCount": 0,
"colorSpace": "string",
"usages": ["string"
]
}
]
},
"validation": {"status": "valid",
"validator": "string",
"validatorVersion": "string",
"rules": ["string"
],
"issues": [{"code": "string",
"severity": "error",
"message": "string",
"location": "string"
}
]
},
"diagnostics": [{"code": "string",
"severity": "error",
"message": "string",
"location": "string"
}
]
},
"analysisSummary": {"schemaVersion": 1,
"sourceFileOid": "stringstringstringstringstringstringstringstringstringstringstri",
"analyzerId": "string",
"analyzerVersion": "string",
"status": "pending",
"analyzedAt": "2019-08-24T14:15:22Z",
"validationStatus": "valid",
"errorCount": 0,
"warningCount": 0,
"data": {"kind": "model",
"dimensions": {"widthMeters": 0,
"depthMeters": 0,
"heightMeters": 0,
"unitSource": "format-defined",
"measurementBasis": "string"
},
"meshCount": 0,
"geometryCount": 0,
"triangleCount": 0,
"vertexCount": 0,
"materialCount": 0,
"textureCount": 0
}
},
"materialInfo": {"version": "string",
"colorspace": "string",
"materials": [{"name": "string",
"category": "string"
}
],
"nodeGraphCount": -9007199254740991,
"topLevelNodeCount": -9007199254740991,
"referencedTextures": ["string"
],
"warnings": ["string"
]
},
"lightInfo": {"version": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"photometricType": 1,
"photometricTypeName": "A",
"photometry": "absolute",
"manufacturer": "string",
"luminaire": "string",
"lightSource": "string",
"lampCatalog": "string",
"lampCount": -9007199254740991,
"lumensPerLamp": 0,
"inputWatts": 0,
"peakCandela": 0,
"verticalAngles": -9007199254740991,
"horizontalAngles": -9007199254740991,
"units": "feet",
"dimensions": {"width": 0,
"length": 0,
"height": 0
},
"hasTilt": true,
"warnings": ["string"
]
}
}

Prepare asset upload

Prepare an asset upload by creating a temporary user upload record and signed URL for direct upload to storage.

Authorizations:

jwtTokensecretToken

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project

Request Body schema: application/json
required

filename required	string [ 1 .. 255 ] characters The filename of the asset
contentType required	string [ 1 .. 255 ] characters The content type of the asset
size required	integer ( 0 .. 9007199254740991 ] The size of the asset

Responses

Request samples

Payload

Content type

application/json

{"filename": "string",
"contentType": "string",
"size": 1
}

Response samples

200
400
401
403
413

Content type

application/json

{"uploadUrl": "http://example.com",
"uploadToken": "string"
}

Delete asset

Delete an asset.

Authorizations:

jwtTokensecretToken

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset

Responses

Response samples

204
400
401
403
404

Content type

application/json

{ }

Get asset

Get asset details by organization, project, and asset name.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string

Responses

Response samples

200
400
401
403
404

Content type

application/json

{"id": -9007199254740991,
"name": "string",
"type": "MODEL",
"visibility": "PRIVATE",
"projectId": -9007199254740991,
"projectName": "string",
"orgId": -9007199254740991,
"orgName": "string",
"description": "string",
"keywords": "string",
"shareLicense": "NONE",
"aiUsage": "UNDISCLOSED",
"commentMode": "ENABLED",
"reported": true,
"likeCount": -9007199254740991,
"shareCount": -9007199254740991,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"archived": true,
"metadata": "string",
"originalSize": -9007199254740991,
"width": null,
"height": null,
"depth": null,
"version": "string",
"latestVersion": "string",
"versionId": -9007199254740991,
"originalExtension": "string",
"fileOid": "string",
"thumbnailOid": null,
"analysis": {"schemaVersion": 1,
"sourceFileOid": "stringstringstringstringstringstringstringstringstringstringstri",
"analyzerId": "string",
"analyzerVersion": "string",
"status": "pending",
"analyzedAt": "2019-08-24T14:15:22Z",
"data": {"kind": "model",
"dimensions": {"widthMeters": 0,
"depthMeters": 0,
"heightMeters": 0,
"unitSource": "format-defined",
"measurementBasis": "string"
},
"meshCount": 0,
"geometryCount": 0,
"triangleCount": 0,
"vertexCount": 0,
"materialCount": 0,
"textureCount": 0,
"textures": [{"id": "string",
"path": "string",
"widthPixels": 0,
"heightPixels": 0,
"format": "string",
"mimeType": "string",
"byteSize": 0,
"mipLevelCount": 0,
"colorSpace": "string",
"usages": ["string"
]
}
]
},
"validation": {"status": "valid",
"validator": "string",
"validatorVersion": "string",
"rules": ["string"
],
"issues": [{"code": "string",
"severity": "error",
"message": "string",
"location": "string"
}
]
},
"diagnostics": [{"code": "string",
"severity": "error",
"message": "string",
"location": "string"
}
]
},
"analysisSummary": {"schemaVersion": 1,
"sourceFileOid": "stringstringstringstringstringstringstringstringstringstringstri",
"analyzerId": "string",
"analyzerVersion": "string",
"status": "pending",
"analyzedAt": "2019-08-24T14:15:22Z",
"validationStatus": "valid",
"errorCount": 0,
"warningCount": 0,
"data": {"kind": "model",
"dimensions": {"widthMeters": 0,
"depthMeters": 0,
"heightMeters": 0,
"unitSource": "format-defined",
"measurementBasis": "string"
},
"meshCount": 0,
"geometryCount": 0,
"triangleCount": 0,
"vertexCount": 0,
"materialCount": 0,
"textureCount": 0
}
},
"materialInfo": {"version": "string",
"colorspace": "string",
"materials": [{"name": "string",
"category": "string"
}
],
"nodeGraphCount": -9007199254740991,
"topLevelNodeCount": -9007199254740991,
"referencedTextures": ["string"
],
"warnings": ["string"
]
},
"lightInfo": {"version": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"photometricType": 1,
"photometricTypeName": "A",
"photometry": "absolute",
"manufacturer": "string",
"luminaire": "string",
"lightSource": "string",
"lampCatalog": "string",
"lampCount": -9007199254740991,
"lumensPerLamp": 0,
"inputWatts": 0,
"peakCandela": 0,
"verticalAngles": -9007199254740991,
"horizontalAngles": -9007199254740991,
"units": "feet",
"dimensions": {"width": 0,
"length": 0,
"height": 0
},
"hasTilt": true,
"warnings": ["string"
]
}
}

Update asset

Update asset metadata including name, description, keywords, visibility, license, and AI usage settings. Can also transfer assets between projects.

Authorizations:

jwtTokensecretToken

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset

Request Body schema: application/json

name	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ Optional name of the asset, to rename asset
description	string <= 10240 characters Optional description of the asset
keywords	string <= 10240 characters Optional keywords of the asset
visibility	string Enum: "PRIVATE" "UNLISTED" "PUBLIC" Optional visibility of the asset
shareLicense	string Enum: "NONE" "CC_0" "CC_BY" "CC_BY_SA" "CC_BY_NC" "CC_BY_NC_SA" "CC_BY_ND" "CC_BY_NC_ND" Optional share license of the asset
aiUsage	string Enum: "UNDISCLOSED" "AI_USED" "AI_FREE" Optional AI usage policy of the asset
commentMode	string Enum: "ENABLED" "MEMBERS_ONLY" "NONE" Optional comment mode: ENABLED, MEMBERS_ONLY, or NONE
projectName	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ Optional project name of the asset, to transfer asset to a different project/organization
orgName	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ Optional organization name of the asset, to transfer asset to a different project/organization
archived	boolean Optional archived status (true to archive, false to unarchive)
metadata	string <= 10240 characters Optional metadata as a string (max 10240 characters)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"keywords": "string",
"visibility": "PRIVATE",
"shareLicense": "NONE",
"aiUsage": "UNDISCLOSED",
"commentMode": "ENABLED",
"projectName": "string",
"orgName": "string",
"archived": true,
"metadata": "string"
}

Response samples

Content type

application/json

{"id": -9007199254740991,
"name": "string",
"type": "MODEL",
"visibility": "PRIVATE",
"projectId": -9007199254740991,
"projectName": "string",
"orgId": -9007199254740991,
"orgName": "string",
"description": "string",
"keywords": "string",
"shareLicense": "NONE",
"aiUsage": "UNDISCLOSED",
"commentMode": "ENABLED",
"reported": true,
"likeCount": -9007199254740991,
"shareCount": -9007199254740991,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"archived": true,
"metadata": "string",
"originalSize": -9007199254740991,
"width": null,
"height": null,
"depth": null,
"version": "string",
"latestVersion": "string",
"versionId": -9007199254740991,
"originalExtension": "string",
"fileOid": "string",
"thumbnailOid": null,
"analysis": {"schemaVersion": 1,
"sourceFileOid": "stringstringstringstringstringstringstringstringstringstringstri",
"analyzerId": "string",
"analyzerVersion": "string",
"status": "pending",
"analyzedAt": "2019-08-24T14:15:22Z",
"data": {"kind": "model",
"dimensions": {"widthMeters": 0,
"depthMeters": 0,
"heightMeters": 0,
"unitSource": "format-defined",
"measurementBasis": "string"
},
"meshCount": 0,
"geometryCount": 0,
"triangleCount": 0,
"vertexCount": 0,
"materialCount": 0,
"textureCount": 0,
"textures": [{"id": "string",
"path": "string",
"widthPixels": 0,
"heightPixels": 0,
"format": "string",
"mimeType": "string",
"byteSize": 0,
"mipLevelCount": 0,
"colorSpace": "string",
"usages": ["string"
]
}
]
},
"validation": {"status": "valid",
"validator": "string",
"validatorVersion": "string",
"rules": ["string"
],
"issues": [{"code": "string",
"severity": "error",
"message": "string",
"location": "string"
}
]
},
"diagnostics": [{"code": "string",
"severity": "error",
"message": "string",
"location": "string"
}
]
},
"analysisSummary": {"schemaVersion": 1,
"sourceFileOid": "stringstringstringstringstringstringstringstringstringstringstri",
"analyzerId": "string",
"analyzerVersion": "string",
"status": "pending",
"analyzedAt": "2019-08-24T14:15:22Z",
"validationStatus": "valid",
"errorCount": 0,
"warningCount": 0,
"data": {"kind": "model",
"dimensions": {"widthMeters": 0,
"depthMeters": 0,
"heightMeters": 0,
"unitSource": "format-defined",
"measurementBasis": "string"
},
"meshCount": 0,
"geometryCount": 0,
"triangleCount": 0,
"vertexCount": 0,
"materialCount": 0,
"textureCount": 0
}
},
"materialInfo": {"version": "string",
"colorspace": "string",
"materials": [{"name": "string",
"category": "string"
}
],
"nodeGraphCount": -9007199254740991,
"topLevelNodeCount": -9007199254740991,
"referencedTextures": ["string"
],
"warnings": ["string"
]
},
"lightInfo": {"version": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"photometricType": 1,
"photometricTypeName": "A",
"photometry": "absolute",
"manufacturer": "string",
"luminaire": "string",
"lightSource": "string",
"lampCatalog": "string",
"lampCount": -9007199254740991,
"lumensPerLamp": 0,
"inputWatts": 0,
"peakCandela": 0,
"verticalAngles": -9007199254740991,
"horizontalAngles": -9007199254740991,
"units": "feet",
"dimensions": {"width": 0,
"length": 0,
"height": 0
},
"hasTilt": true,
"warnings": ["string"
]
}
}

Get asset Blend (media v2)

Get asset as Blend model (read-only). Redirects if cached or already Blend; 404 otherwise. Does not start tasks.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset
version required	string [ 1 .. 128 ] characters ^[a-zA-Z0-9][a-zA-Z0-9._+-]*$

query Parameters

download	boolean
original	boolean

Responses

Response samples

302
400
403
404

Content type

application/json

{"redirectUrl": "string"
}

POST asset Blend (media v2)

Start or return existing Blend conversion task. Always returns 202 task status payload.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset
version required	string [ 1 .. 128 ] characters ^[a-zA-Z0-9][a-zA-Z0-9._+-]*$

query Parameters

download	boolean
original	boolean
cache	boolean

Responses

Response samples

202
400
403
404

Content type

application/json

{"status": "QUEUED",
"taskId": -9007199254740991,
"taskUrl": "http://example.com",
"eventsUrl": "http://example.com"
}

Get asset Blend (media v2)

Get asset as Blend model (read-only). Redirects if cached or already Blend; 404 otherwise. Does not start tasks.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset

query Parameters

download	boolean
original	boolean

Responses

Response samples

302
400
403
404

Content type

application/json

{"redirectUrl": "string"
}

POST asset Blend (media v2)

Start or return existing Blend conversion task. Always returns 202 task status payload.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset

query Parameters

download	boolean
original	boolean
cache	boolean

Responses

Response samples

202
400
403
404

Content type

application/json

{"status": "QUEUED",
"taskId": -9007199254740991,
"taskUrl": "http://example.com",
"eventsUrl": "http://example.com"
}

Get asset EXR (media v2)

Get asset as EXR environment map (read-only). Redirects if cached; 404 otherwise. ENVMAP only.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset
version required	string [ 1 .. 128 ] characters ^[a-zA-Z0-9][a-zA-Z0-9._+-]*$

query Parameters

download	boolean
original	boolean

Responses

Response samples

302
400
403
404

Content type

application/json

{"redirectUrl": "string"
}

POST asset EXR (media v2)

Start or return existing EXR conversion task. ENVMAP only. 302 if done, 202 with task URLs otherwise.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset
version required	string [ 1 .. 128 ] characters ^[a-zA-Z0-9][a-zA-Z0-9._+-]*$

query Parameters

download	boolean
original	boolean
cache	boolean

Responses

Response samples

202
302
400
403
404

Content type

application/json

{"status": "QUEUED",
"taskId": -9007199254740991,
"taskUrl": "http://example.com",
"eventsUrl": "http://example.com"
}

Get asset EXR (media v2)

Get asset as EXR environment map (read-only). Redirects if cached; 404 otherwise. ENVMAP only.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset

query Parameters

download	boolean
original	boolean

Responses

Response samples

302
400
403
404

Content type

application/json

{"redirectUrl": "string"
}

POST asset EXR (media v2)

Start or return existing EXR conversion task. ENVMAP only. 302 if done, 202 with task URLs otherwise.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset

query Parameters

download	boolean
original	boolean
cache	boolean

Responses

Response samples

202
302
400
403
404

Content type

application/json

{"status": "QUEUED",
"taskId": -9007199254740991,
"taskUrl": "http://example.com",
"eventsUrl": "http://example.com"
}

Get asset FBX (media v2)

Get asset as FBX model (read-only). Redirects if cached or already FBX; 404 otherwise. Does not start tasks.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset
version required	string [ 1 .. 128 ] characters ^[a-zA-Z0-9][a-zA-Z0-9._+-]*$

query Parameters

download	boolean
original	boolean

Responses

Response samples

302
400
403
404

Content type

application/json

{"redirectUrl": "string"
}

POST asset FBX (media v2)

Start or return existing FBX conversion task. Always returns 202 task status payload.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset
version required	string [ 1 .. 128 ] characters ^[a-zA-Z0-9][a-zA-Z0-9._+-]*$

query Parameters

download	boolean
original	boolean
cache	boolean

Responses

Response samples

202
400
403
404

Content type

application/json

{"status": "QUEUED",
"taskId": -9007199254740991,
"taskUrl": "http://example.com",
"eventsUrl": "http://example.com"
}

Get asset FBX (media v2)

Get asset as FBX model (read-only). Redirects if cached or already FBX; 404 otherwise. Does not start tasks.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset

query Parameters

download	boolean
original	boolean

Responses

Response samples

302
400
403
404

Content type

application/json

{"redirectUrl": "string"
}

POST asset FBX (media v2)

Start or return existing FBX conversion task. Always returns 202 task status payload.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset

query Parameters

download	boolean
original	boolean
cache	boolean

Responses

Response samples

202
400
403
404

Content type

application/json

{"status": "QUEUED",
"taskId": -9007199254740991,
"taskUrl": "http://example.com",
"eventsUrl": "http://example.com"
}

Get asset FCStd CAD (media v2)

Get asset as FCStd CAD file (read-only). Redirects if cached or already FCStd; 404 otherwise. Does not start tasks.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset
version required	string [ 1 .. 128 ] characters ^[a-zA-Z0-9][a-zA-Z0-9._+-]*$

query Parameters

download	boolean
original	boolean

Responses

Response samples

302
400
403
404

Content type

application/json

{"redirectUrl": "string"
}

POST asset FCStd CAD (media v2)

Start or return existing FCStd CAD conversion task. Always returns 202 task status payload.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset
version required	string [ 1 .. 128 ] characters ^[a-zA-Z0-9][a-zA-Z0-9._+-]*$

query Parameters

download	boolean
original	boolean
cache	boolean

Responses

Response samples

202
400
403
404

Content type

application/json

{"status": "QUEUED",
"taskId": -9007199254740991,
"taskUrl": "http://example.com",
"eventsUrl": "http://example.com"
}

Get asset FCStd CAD (media v2)

Get asset as FCStd CAD file (read-only). Redirects if cached or already FCStd; 404 otherwise. Does not start tasks.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset

query Parameters

download	boolean
original	boolean

Responses

Response samples

302
400
403
404

Content type

application/json

{"redirectUrl": "string"
}

POST asset FCStd CAD (media v2)

Start or return existing FCStd CAD conversion task. Always returns 202 task status payload.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset

query Parameters

download	boolean
original	boolean
cache	boolean

Responses

Response samples

202
400
403
404

Content type

application/json

{"status": "QUEUED",
"taskId": -9007199254740991,
"taskUrl": "http://example.com",
"eventsUrl": "http://example.com"
}

Get asset GLB (media v2)

Get asset as GLB model (read-only). Redirects if cached or already GLB; 404 otherwise. Does not start tasks.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset
version required	string [ 1 .. 128 ] characters ^[a-zA-Z0-9][a-zA-Z0-9._+-]*$

query Parameters

original	boolean
download	boolean
meshCompress	string Enum: "draco" "meshopt" "quantize"
textureCompress	string Enum: "ktx2" "webp" "avif" "auto"

Responses

Response samples

302
400
403
404

Content type

application/json

{"redirectUrl": "string"
}

POST asset GLB (media v2)

Start or return existing GLB conversion/optimization task. Always returns 202 task status payload.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset
version required	string [ 1 .. 128 ] characters ^[a-zA-Z0-9][a-zA-Z0-9._+-]*$

query Parameters

original	boolean
download	boolean
meshCompress	string Enum: "draco" "meshopt" "quantize"
textureCompress	string Enum: "ktx2" "webp" "avif" "auto"
cache	boolean

Responses

Response samples

202
400
403
404

Content type

application/json

{"status": "QUEUED",
"taskId": -9007199254740991,
"taskUrl": "http://example.com",
"eventsUrl": "http://example.com"
}

Get asset GLB (media v2)

Get asset as GLB model (read-only). Redirects if cached or already GLB; 404 otherwise. Does not start tasks.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset

query Parameters

original	boolean
download	boolean
meshCompress	string Enum: "draco" "meshopt" "quantize"
textureCompress	string Enum: "ktx2" "webp" "avif" "auto"

Responses

Response samples

302
400
403
404

Content type

application/json

{"redirectUrl": "string"
}

POST asset GLB (media v2)

Start or return existing GLB conversion/optimization task. Always returns 202 task status payload.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset

query Parameters

original	boolean
download	boolean
meshCompress	string Enum: "draco" "meshopt" "quantize"
textureCompress	string Enum: "ktx2" "webp" "avif" "auto"
cache	boolean

Responses

Response samples

202
400
403
404

Content type

application/json

{"status": "QUEUED",
"taskId": -9007199254740991,
"taskUrl": "http://example.com",
"eventsUrl": "http://example.com"
}

Get asset HDR (media v2)

Get asset as HDR environment map (read-only). Redirects if cached; 404 otherwise. ENVMAP only.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset
version required	string [ 1 .. 128 ] characters ^[a-zA-Z0-9][a-zA-Z0-9._+-]*$

query Parameters

download	boolean
original	boolean

Responses

Response samples

302
400
403
404

Content type

application/json

{"redirectUrl": "string"
}

POST asset HDR (media v2)

Start or return existing HDR conversion task. ENVMAP only. 302 if done, 202 with task URLs otherwise.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset
version required	string [ 1 .. 128 ] characters ^[a-zA-Z0-9][a-zA-Z0-9._+-]*$

query Parameters

download	boolean
original	boolean
cache	boolean

Responses

Response samples

202
302
400
403
404

Content type

application/json

{"status": "QUEUED",
"taskId": -9007199254740991,
"taskUrl": "http://example.com",
"eventsUrl": "http://example.com"
}

Get asset HDR (media v2)

Get asset as HDR environment map (read-only). Redirects if cached; 404 otherwise. ENVMAP only.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset

query Parameters

download	boolean
original	boolean

Responses

Response samples

302
400
403
404

Content type

application/json

{"redirectUrl": "string"
}

POST asset HDR (media v2)

Start or return existing HDR conversion task. ENVMAP only. 302 if done, 202 with task URLs otherwise.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset

query Parameters

download	boolean
original	boolean
cache	boolean

Responses

Response samples

202
302
400
403
404

Content type

application/json

{"status": "QUEUED",
"taskId": -9007199254740991,
"taskUrl": "http://example.com",
"eventsUrl": "http://example.com"
}

Get asset IGES CAD (media v2)

Get asset as IGES CAD file (read-only). Redirects if cached or already IGES; 404 otherwise. Does not start tasks.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset
version required	string [ 1 .. 128 ] characters ^[a-zA-Z0-9][a-zA-Z0-9._+-]*$

query Parameters

download	boolean
original	boolean

Responses

Response samples

302
400
403
404

Content type

application/json

{"redirectUrl": "string"
}

POST asset IGES CAD (media v2)

Start or return existing IGES CAD conversion task. Always returns 202 task status payload.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset
version required	string [ 1 .. 128 ] characters ^[a-zA-Z0-9][a-zA-Z0-9._+-]*$

query Parameters

download	boolean
original	boolean
cache	boolean

Responses

Response samples

202
400
403
404

Content type

application/json

{"status": "QUEUED",
"taskId": -9007199254740991,
"taskUrl": "http://example.com",
"eventsUrl": "http://example.com"
}

Get asset IGES CAD (media v2)

Get asset as IGES CAD file (read-only). Redirects if cached or already IGES; 404 otherwise. Does not start tasks.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset

query Parameters

download	boolean
original	boolean

Responses

Response samples

302
400
403
404

Content type

application/json

{"redirectUrl": "string"
}

POST asset IGES CAD (media v2)

Start or return existing IGES CAD conversion task. Always returns 202 task status payload.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset

query Parameters

download	boolean
original	boolean
cache	boolean

Responses

Response samples

202
400
403
404

Content type

application/json

{"status": "QUEUED",
"taskId": -9007199254740991,
"taskUrl": "http://example.com",
"eventsUrl": "http://example.com"
}

Get asset STEP CAD (media v2)

Get asset as STEP CAD file (read-only). Redirects if cached or already STEP; 404 otherwise. Does not start tasks.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset
version required	string [ 1 .. 128 ] characters ^[a-zA-Z0-9][a-zA-Z0-9._+-]*$

query Parameters

download	boolean
original	boolean

Responses

Response samples

302
400
403
404

Content type

application/json

{"redirectUrl": "string"
}

POST asset STEP CAD (media v2)

Start or return existing STEP CAD conversion task. Always returns 202 task status payload.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset
version required	string [ 1 .. 128 ] characters ^[a-zA-Z0-9][a-zA-Z0-9._+-]*$

query Parameters

download	boolean
original	boolean
cache	boolean

Responses

Response samples

202
400
403
404

Content type

application/json

{"status": "QUEUED",
"taskId": -9007199254740991,
"taskUrl": "http://example.com",
"eventsUrl": "http://example.com"
}

Get asset STEP CAD (media v2)

Get asset as STEP CAD file (read-only). Redirects if cached or already STEP; 404 otherwise. Does not start tasks.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset

query Parameters

download	boolean
original	boolean

Responses

Response samples

302
400
403
404

Content type

application/json

{"redirectUrl": "string"
}

POST asset STEP CAD (media v2)

Start or return existing STEP CAD conversion task. Always returns 202 task status payload.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset

query Parameters

download	boolean
original	boolean
cache	boolean

Responses

Response samples

202
400
403
404

Content type

application/json

{"status": "QUEUED",
"taskId": -9007199254740991,
"taskUrl": "http://example.com",
"eventsUrl": "http://example.com"
}

Get asset UltraHDR (media v2)

Get asset as UltraHDR image (read-only). Redirects if cached; 404 otherwise. ENVMAP only.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset
version required	string [ 1 .. 128 ] characters ^[a-zA-Z0-9][a-zA-Z0-9._+-]*$

query Parameters

download	boolean
original	boolean

Responses

Response samples

302
400
403
404

Content type

application/json

{"redirectUrl": "string"
}

POST asset UltraHDR (media v2)

Start or return existing UltraHDR conversion task. ENVMAP only. 302 if done, 202 with task URLs otherwise.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset
version required	string [ 1 .. 128 ] characters ^[a-zA-Z0-9][a-zA-Z0-9._+-]*$

query Parameters

download	boolean
original	boolean
cache	boolean

Responses

Response samples

202
302
400
403
404

Content type

application/json

{"status": "QUEUED",
"taskId": -9007199254740991,
"taskUrl": "http://example.com",
"eventsUrl": "http://example.com"
}

Get asset UltraHDR (media v2)

Get asset as UltraHDR image (read-only). Redirects if cached; 404 otherwise. ENVMAP only.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset

query Parameters

download	boolean
original	boolean

Responses

Response samples

302
400
403
404

Content type

application/json

{"redirectUrl": "string"
}

POST asset UltraHDR (media v2)

Start or return existing UltraHDR conversion task. ENVMAP only. 302 if done, 202 with task URLs otherwise.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset

query Parameters

download	boolean
original	boolean
cache	boolean

Responses

Response samples

202
302
400
403
404

Content type

application/json

{"status": "QUEUED",
"taskId": -9007199254740991,
"taskUrl": "http://example.com",
"eventsUrl": "http://example.com"
}

Get asset USDZ (media v2)

Get asset as USDZ model (read-only). Redirects if cached or already USDZ; 404 otherwise. Does not start tasks.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset
version required	string [ 1 .. 128 ] characters ^[a-zA-Z0-9][a-zA-Z0-9._+-]*$

query Parameters

download	boolean
original	boolean

Responses

Response samples

302
400
403
404

Content type

application/json

{"redirectUrl": "string"
}

POST asset USDZ (media v2)

Start or return existing USDZ conversion task. Always returns 202 task status payload.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset
version required	string [ 1 .. 128 ] characters ^[a-zA-Z0-9][a-zA-Z0-9._+-]*$

query Parameters

download	boolean
original	boolean
cache	boolean

Responses

Response samples

202
400
403
404

Content type

application/json

{"status": "QUEUED",
"taskId": -9007199254740991,
"taskUrl": "http://example.com",
"eventsUrl": "http://example.com"
}

Get asset USDZ (media v2)

Get asset as USDZ model (read-only). Redirects if cached or already USDZ; 404 otherwise. Does not start tasks.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset

query Parameters

download	boolean
original	boolean

Responses

Response samples

302
400
403
404

Content type

application/json

{"redirectUrl": "string"
}

POST asset USDZ (media v2)

Start or return existing USDZ conversion task. Always returns 202 task status payload.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset

query Parameters

download	boolean
original	boolean
cache	boolean

Responses

Response samples

202
400
403
404

Content type

application/json

{"status": "QUEUED",
"taskId": -9007199254740991,
"taskUrl": "http://example.com",
"eventsUrl": "http://example.com"
}

Get asset WebP (media v2)

Get asset as WebP image (read-only). Redirects to file if a cached result exists; 404 otherwise. Does not start tasks.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset
version required	string [ 1 .. 128 ] characters ^[a-zA-Z0-9][a-zA-Z0-9._+-]*$

query Parameters

width	integer ( 0 .. 9007199254740991 ] The width of the resized image
height	integer ( 0 .. 9007199254740991 ] The height of the resized image
quality	integer [ 1 .. 100 ] The quality of the resized image
download	boolean
original	boolean

Responses

Response samples

302
400
403
404

Content type

application/json

{"redirectUrl": "string"
}

POST asset WebP (media v2)

Start or return existing WebP image/thumbnail task. Returns 302 if already complete, 202 with task URLs otherwise.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset
version required	string [ 1 .. 128 ] characters ^[a-zA-Z0-9][a-zA-Z0-9._+-]*$

query Parameters

width	integer ( 0 .. 9007199254740991 ] The width of the resized image
height	integer ( 0 .. 9007199254740991 ] The height of the resized image
quality	integer [ 1 .. 100 ] The quality of the resized image
download	boolean
original	boolean
cache	boolean

Responses

Response samples

202
302
400
403
404

Content type

application/json

{"status": "QUEUED",
"taskId": -9007199254740991,
"taskUrl": "http://example.com",
"eventsUrl": "http://example.com"
}

Get asset WebP (media v2)

Get asset as WebP image (read-only). Redirects to file if a cached result exists; 404 otherwise. Does not start tasks.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset

query Parameters

width	integer ( 0 .. 9007199254740991 ] The width of the resized image
height	integer ( 0 .. 9007199254740991 ] The height of the resized image
quality	integer [ 1 .. 100 ] The quality of the resized image
download	boolean
original	boolean

Responses

Response samples

302
400
403
404

Content type

application/json

{"redirectUrl": "string"
}

POST asset WebP (media v2)

Start or return existing WebP image/thumbnail task. Returns 302 if already complete, 202 with task URLs otherwise.

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset

query Parameters

width	integer ( 0 .. 9007199254740991 ] The width of the resized image
height	integer ( 0 .. 9007199254740991 ] The height of the resized image
quality	integer [ 1 .. 100 ] The quality of the resized image
download	boolean
original	boolean
cache	boolean

Responses

Response samples

202
302
400
403
404

Content type

application/json

{"status": "QUEUED",
"taskId": -9007199254740991,
"taskUrl": "http://example.com",
"eventsUrl": "http://example.com"
}

Download original content using its source extension

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string <= 128 characters
version required	string <= 256 characters

query Parameters

download	boolean
original	boolean

Responses

Response samples

302
400
403
404

Content type

application/json

{"redirectUrl": "string"
}

Download original content using its source extension

Authorizations:

jwtTokensecretTokenfrontendTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string <= 128 characters

query Parameters

download	boolean
original	boolean

Responses

Response samples

302
400
403
404

Content type

application/json

{"redirectUrl": "string"
}

List asset versions

Authorizations:

jwtTokensecretTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset

Responses

Response samples

200
400
403
404

Content type

application/json

[{"originalExtension": "string",
"analysis": {"schemaVersion": 1,
"sourceFileOid": "stringstringstringstringstringstringstringstringstringstringstri",
"analyzerId": "string",
"analyzerVersion": "string",
"status": "pending",
"analyzedAt": "2019-08-24T14:15:22Z",
"data": {"kind": "model",
"dimensions": {"widthMeters": 0,
"depthMeters": 0,
"heightMeters": 0,
"unitSource": "format-defined",
"measurementBasis": "string"
},
"meshCount": 0,
"geometryCount": 0,
"triangleCount": 0,
"vertexCount": 0,
"materialCount": 0,
"textureCount": 0,
"textures": [{"id": "string",
"path": "string",
"widthPixels": 0,
"heightPixels": 0,
"format": "string",
"mimeType": "string",
"byteSize": 0,
"mipLevelCount": 0,
"colorSpace": "string",
"usages": ["string"
]
}
]
},
"validation": {"status": "valid",
"validator": "string",
"validatorVersion": "string",
"rules": ["string"
],
"issues": [{"code": "string",
"severity": "error",
"message": "string",
"location": "string"
}
]
},
"diagnostics": [{"code": "string",
"severity": "error",
"message": "string",
"location": "string"
}
]
},
"analysisSummary": {"schemaVersion": 1,
"sourceFileOid": "stringstringstringstringstringstringstringstringstringstringstri",
"analyzerId": "string",
"analyzerVersion": "string",
"status": "pending",
"analyzedAt": "2019-08-24T14:15:22Z",
"validationStatus": "valid",
"errorCount": 0,
"warningCount": 0,
"data": {"kind": "model",
"dimensions": {"widthMeters": 0,
"depthMeters": 0,
"heightMeters": 0,
"unitSource": "format-defined",
"measurementBasis": "string"
},
"meshCount": 0,
"geometryCount": 0,
"triangleCount": 0,
"vertexCount": 0,
"materialCount": 0,
"textureCount": 0
}
},
"description": "",
"id": -9007199254740991,
"assetId": -9007199254740991,
"version": "string",
"fileOid": "string",
"thumbnailOid": null,
"createdAt": "2019-08-24T14:15:22Z",
"createdByUserId": -9007199254740991,
"createdByUserName": null,
"originalSize": -9007199254740991
}
]

Upload an immutable asset version

Upload an unused exact version, or omit version to increment the highest major.

Authorizations:

jwtTokensecretToken

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset

Request Body schema: application/json
required

description	string <= 10240 characters The description of the entity
uploadToken required	string
version	string^(0\|[1-9][0-9])\.(0\|[1-9][0-9])\.(0\|[1-9][0...

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"uploadToken": "string",
"version": "string"
}

Response samples

Content type

application/json

{"id": -9007199254740991,
"name": "string",
"type": "MODEL",
"visibility": "PRIVATE",
"projectId": -9007199254740991,
"projectName": "string",
"orgId": -9007199254740991,
"orgName": "string",
"description": "string",
"keywords": "string",
"shareLicense": "NONE",
"aiUsage": "UNDISCLOSED",
"commentMode": "ENABLED",
"reported": true,
"likeCount": -9007199254740991,
"shareCount": -9007199254740991,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"archived": true,
"metadata": "string",
"originalSize": -9007199254740991,
"width": null,
"height": null,
"depth": null,
"version": "string",
"latestVersion": "string",
"versionId": -9007199254740991,
"originalExtension": "string",
"fileOid": "string",
"thumbnailOid": null,
"analysis": {"schemaVersion": 1,
"sourceFileOid": "stringstringstringstringstringstringstringstringstringstringstri",
"analyzerId": "string",
"analyzerVersion": "string",
"status": "pending",
"analyzedAt": "2019-08-24T14:15:22Z",
"data": {"kind": "model",
"dimensions": {"widthMeters": 0,
"depthMeters": 0,
"heightMeters": 0,
"unitSource": "format-defined",
"measurementBasis": "string"
},
"meshCount": 0,
"geometryCount": 0,
"triangleCount": 0,
"vertexCount": 0,
"materialCount": 0,
"textureCount": 0,
"textures": [{"id": "string",
"path": "string",
"widthPixels": 0,
"heightPixels": 0,
"format": "string",
"mimeType": "string",
"byteSize": 0,
"mipLevelCount": 0,
"colorSpace": "string",
"usages": ["string"
]
}
]
},
"validation": {"status": "valid",
"validator": "string",
"validatorVersion": "string",
"rules": ["string"
],
"issues": [{"code": "string",
"severity": "error",
"message": "string",
"location": "string"
}
]
},
"diagnostics": [{"code": "string",
"severity": "error",
"message": "string",
"location": "string"
}
]
},
"analysisSummary": {"schemaVersion": 1,
"sourceFileOid": "stringstringstringstringstringstringstringstringstringstringstri",
"analyzerId": "string",
"analyzerVersion": "string",
"status": "pending",
"analyzedAt": "2019-08-24T14:15:22Z",
"validationStatus": "valid",
"errorCount": 0,
"warningCount": 0,
"data": {"kind": "model",
"dimensions": {"widthMeters": 0,
"depthMeters": 0,
"heightMeters": 0,
"unitSource": "format-defined",
"measurementBasis": "string"
},
"meshCount": 0,
"geometryCount": 0,
"triangleCount": 0,
"vertexCount": 0,
"materialCount": 0,
"textureCount": 0
}
},
"materialInfo": {"version": "string",
"colorspace": "string",
"materials": [{"name": "string",
"category": "string"
}
],
"nodeGraphCount": -9007199254740991,
"topLevelNodeCount": -9007199254740991,
"referencedTextures": ["string"
],
"warnings": ["string"
]
},
"lightInfo": {"version": "string",
"metadata": {"property1": "string",
"property2": "string"
},
"photometricType": 1,
"photometricTypeName": "A",
"photometry": "absolute",
"manufacturer": "string",
"luminaire": "string",
"lightSource": "string",
"lampCatalog": "string",
"lampCount": -9007199254740991,
"lumensPerLamp": 0,
"inputWatts": 0,
"peakCandela": 0,
"verticalAngles": -9007199254740991,
"horizontalAngles": -9007199254740991,
"units": "feet",
"dimensions": {"width": 0,
"length": 0,
"height": 0
},
"hasTilt": true,
"warnings": ["string"
]
}
}

Update an asset version description

Authorizations:

jwtTokensecretToken

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset
version required	string^(0\|[1-9][0-9])\.(0\|[1-9][0-9])\.(0\|[1-9][0...

Request Body schema: application/json
required

description

required

string <= 10240 characters

The description of the entity

Responses

Request samples

Payload

Content type

application/json

{"description": "string"
}

Response samples

200
400
401
403
404

Content type

application/json

{"originalExtension": "string",
"analysis": {"schemaVersion": 1,
"sourceFileOid": "stringstringstringstringstringstringstringstringstringstringstri",
"analyzerId": "string",
"analyzerVersion": "string",
"status": "pending",
"analyzedAt": "2019-08-24T14:15:22Z",
"data": {"kind": "model",
"dimensions": {"widthMeters": 0,
"depthMeters": 0,
"heightMeters": 0,
"unitSource": "format-defined",
"measurementBasis": "string"
},
"meshCount": 0,
"geometryCount": 0,
"triangleCount": 0,
"vertexCount": 0,
"materialCount": 0,
"textureCount": 0,
"textures": [{"id": "string",
"path": "string",
"widthPixels": 0,
"heightPixels": 0,
"format": "string",
"mimeType": "string",
"byteSize": 0,
"mipLevelCount": 0,
"colorSpace": "string",
"usages": ["string"
]
}
]
},
"validation": {"status": "valid",
"validator": "string",
"validatorVersion": "string",
"rules": ["string"
],
"issues": [{"code": "string",
"severity": "error",
"message": "string",
"location": "string"
}
]
},
"diagnostics": [{"code": "string",
"severity": "error",
"message": "string",
"location": "string"
}
]
},
"analysisSummary": {"schemaVersion": 1,
"sourceFileOid": "stringstringstringstringstringstringstringstringstringstringstri",
"analyzerId": "string",
"analyzerVersion": "string",
"status": "pending",
"analyzedAt": "2019-08-24T14:15:22Z",
"validationStatus": "valid",
"errorCount": 0,
"warningCount": 0,
"data": {"kind": "model",
"dimensions": {"widthMeters": 0,
"depthMeters": 0,
"heightMeters": 0,
"unitSource": "format-defined",
"measurementBasis": "string"
},
"meshCount": 0,
"geometryCount": 0,
"triangleCount": 0,
"vertexCount": 0,
"materialCount": 0,
"textureCount": 0
}
},
"description": "",
"id": -9007199254740991,
"assetId": -9007199254740991,
"version": "string",
"fileOid": "string",
"thumbnailOid": null,
"createdAt": "2019-08-24T14:15:22Z",
"createdByUserId": -9007199254740991,
"createdByUserName": null,
"originalSize": -9007199254740991
}

Products

List products

List products in a project. Requires project read access. Products are private.

Authorizations:

jwtTokensecretToken

query Parameters

pageOffset	integer [ 0 .. 9007199254740991 ] The number of items to skip before starting to return results. Must be 0 or greater.
pageSize	integer [ 1 .. 1000 ] The maximum number of items to return. Must be between 1 and 1000.
sortBy	string Enum: "createdAt" "updatedAt" "code" "name" The field to sort by
sortDir	string Enum: "asc" "desc" The direction to sort by
orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ Organization name
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ Project name

Responses

Response samples

200
400
401
403
404

Content type

application/json

{"rows": [{"id": -9007199254740991,
"code": "string",
"name": "string",
"description": "string",
"projectId": -9007199254740991,
"projectName": "string",
"orgId": -9007199254740991,
"orgName": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"referenceImages": [{"id": -9007199254740991,
"productId": -9007199254740991,
"description": "string",
"fileOid": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"firstReferenceImageOid": null
}
],
"rowCount": 0
}

Create product

Create a new product in a project. Requires project update access.

Authorizations:

jwtTokensecretToken

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project

Request Body schema: application/json
required

code required	string [ 1 .. 100 ] characters ^[a-zA-Z0-9][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The code of the product (unique within project)
name required	string <= 1024 characters The display name of the product
description	string <= 10240 characters Optional description of the product

Responses

Request samples

Payload

Content type

application/json

{"code": "string",
"name": "string",
"description": "string"
}

Response samples

201
400
401
403
404

Content type

application/json

{"id": -9007199254740991,
"code": "string",
"name": "string",
"description": "string",
"projectId": -9007199254740991,
"projectName": "string",
"orgId": -9007199254740991,
"orgName": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"referenceImages": [{"id": -9007199254740991,
"productId": -9007199254740991,
"description": "string",
"fileOid": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"firstReferenceImageOid": null
}

Delete product

Delete a product. Requires project update access.

Authorizations:

jwtTokensecretToken

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
productCode required	string [ 1 .. 100 ] characters ^[a-zA-Z0-9][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The code of the product (unique within project)

Responses

Response samples

204
400
401
403
404

Content type

application/json

{ }

Get product

Get product details by organization, project, and product code. Requires project read access.

Authorizations:

jwtTokensecretToken

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
productCode required	string [ 1 .. 100 ] characters ^[a-zA-Z0-9][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The code of the product (unique within project)

Responses

Response samples

200
400
401
403
404

Content type

application/json

{"id": -9007199254740991,
"code": "string",
"name": "string",
"description": "string",
"projectId": -9007199254740991,
"projectName": "string",
"orgId": -9007199254740991,
"orgName": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"referenceImages": [{"id": -9007199254740991,
"productId": -9007199254740991,
"description": "string",
"fileOid": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"firstReferenceImageOid": null
}

Update product

Update a product. Requires project update access.

Authorizations:

jwtTokensecretToken

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
productCode required	string [ 1 .. 100 ] characters ^[a-zA-Z0-9][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The code of the product (unique within project)

Request Body schema: application/json

code	string [ 1 .. 100 ] characters ^[a-zA-Z0-9][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ New code (unique within project)
name	string <= 1024 characters Display name
description	string <= 10240 characters Description

Responses

Request samples

Payload

Content type

application/json

{"code": "string",
"name": "string",
"description": "string"
}

Response samples

200
400
401
403
404

Content type

application/json

{"id": -9007199254740991,
"code": "string",
"name": "string",
"description": "string",
"projectId": -9007199254740991,
"projectName": "string",
"orgId": -9007199254740991,
"orgName": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"referenceImages": [{"id": -9007199254740991,
"productId": -9007199254740991,
"description": "string",
"fileOid": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"firstReferenceImageOid": null
}

Reference Images

Create reference image

Add a reference image to a product. Requires project update access. Use prepare-upload (assets) to get uploadToken.

Authorizations:

jwtTokensecretToken

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
productCode required	string [ 1 .. 100 ] characters ^[a-zA-Z0-9][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The code of the product (unique within project)

Request Body schema: application/json
required

uploadToken required	string Upload token from prepare-upload
description	string <= 10240 characters Optional description for the reference image

Responses

Request samples

Payload

Content type

application/json

{"uploadToken": "string",
"description": "string"
}

Response samples

201
400
401
403
404

Content type

application/json

{"id": -9007199254740991,
"productId": -9007199254740991,
"description": "string",
"fileOid": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Delete reference image

Delete a reference image. Requires project update access.

Authorizations:

jwtTokensecretToken

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
productCode required	string [ 1 .. 100 ] characters ^[a-zA-Z0-9][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The code of the product (unique within project)
referenceImageId required	integer [ -9007199254740991 .. 9007199254740991 ] The ID of the reference image

Responses

Response samples

204
400
401
403
404

Content type

application/json

{ }

Get reference image

Get a reference image by ID. Requires project read access.

Authorizations:

jwtTokensecretToken

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
productCode required	string [ 1 .. 100 ] characters ^[a-zA-Z0-9][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The code of the product (unique within project)
referenceImageId required	integer [ -9007199254740991 .. 9007199254740991 ] The ID of the reference image

Responses

Response samples

200
400
401
403
404

Content type

application/json

{"id": -9007199254740991,
"productId": -9007199254740991,
"description": "string",
"fileOid": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Update reference image

Update a reference image (e.g. description). Requires project update access.

Authorizations:

jwtTokensecretToken

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
productCode required	string [ 1 .. 100 ] characters ^[a-zA-Z0-9][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The code of the product (unique within project)
referenceImageId required	integer [ -9007199254740991 .. 9007199254740991 ] The ID of the reference image

Request Body schema: application/json

description

string <= 10240 characters

Description for the reference image

Responses

Request samples

Payload

Content type

application/json

{"description": "string"
}

Response samples

200
400
401
403
404

Content type

application/json

{"id": -9007199254740991,
"productId": -9007199254740991,
"description": "string",
"fileOid": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Comments

List comments

List comments for an asset, addressed by org, project, and asset name.

Authorizations:

jwtTokensecretTokenNone

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset

query Parameters

pageOffset	integer [ 0 .. 9007199254740991 ] The number of items to skip before starting to return results. Must be 0 or greater.
pageSize	integer [ 1 .. 1000 ] The maximum number of items to return. Must be between 1 and 1000.
sortBy	string Value: "createdAt" The field to sort by
sortDir	string Enum: "asc" "desc" The direction to sort by

Responses

Response samples

200
400
401
403
404

Content type

application/json

{"rows": [{"id": -9007199254740991,
"text": "string",
"likeCount": 0,
"createdAt": "2019-08-24T14:15:22Z",
"moderatedAt": "2019-08-24T14:15:22Z",
"moderationReason": null,
"createdByUserId": -9007199254740991,
"createdByName": "string",
"likeId": -9007199254740991
}
],
"rowCount": 0
}

Create comment

Create a comment on an asset, addressed by org, project, and asset name.

Authorizations:

jwtTokensecretToken

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset

Request Body schema: application/json
required

text

required

string [ 1 .. 10240 ] characters

The comment text

Responses

Request samples

Payload

Content type

application/json

{"text": "string"
}

Response samples

201
400
401
403
404

Content type

application/json

{"id": -9007199254740991,
"text": "string",
"likeCount": 0,
"createdAt": "2019-08-24T14:15:22Z",
"moderatedAt": "2019-08-24T14:15:22Z",
"moderationReason": null,
"createdByUserId": -9007199254740991,
"createdByName": "string",
"likeId": -9007199254740991
}

Delete comment

Delete a comment on an asset, addressed by org, project, asset, and comment id.

Authorizations:

jwtTokensecretToken

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset
commentId required	integer [ -9007199254740991 .. 9007199254740991 ] The ID of the comment

Responses

Response samples

204
400
401
403
404

Content type

application/json

{ }

Edit comment

Edit a comment on an asset, addressed by org, project, asset, and comment id.

Authorizations:

jwtTokensecretToken

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
assetName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the asset
commentId required	integer [ -9007199254740991 .. 9007199254740991 ] The ID of the comment

Request Body schema: application/json
required

text

required

string [ 1 .. 10240 ] characters

The updated comment text

Responses

Request samples

Payload

Content type

application/json

{"text": "string"
}

Response samples

200
400
401
403
404

Content type

application/json

{"id": -9007199254740991,
"text": "string",
"likeCount": 0,
"createdAt": "2019-08-24T14:15:22Z",
"moderatedAt": "2019-08-24T14:15:22Z",
"moderationReason": null,
"createdByUserId": -9007199254740991,
"createdByName": "string",
"likeId": -9007199254740991
}

Notifications

List notifications

List notifications for the authenticated user, with optional filtering by status and support for pagination and sorting.

Authorizations:

jwtTokensecretToken

query Parameters

pageOffset	integer [ 0 .. 9007199254740991 ] The number of items to skip before starting to return results. Must be 0 or greater.
pageSize	integer [ 1 .. 1000 ] The maximum number of items to return. Must be between 1 and 1000.
sortBy	string Enum: "createdAt" "status" The field to sort by
sortDir	string Enum: "asc" "desc" The direction to sort by
status	string Enum: "UNREAD" "READ" Filter by status (UNREAD or READ)

Responses

Response samples

200
400
401
403

Content type

application/json

{"rows": [{"id": -9007199254740991,
"title": "string",
"body": "string",
"createdAt": "2019-08-24T14:15:22Z",
"status": "UNREAD",
"topic": "NEW_COMMENT",
"imageUrl": null,
"link": null,
"userId": -9007199254740991,
"userName": "string"
}
],
"rowCount": 0
}

Mark all notifications as read

Mark all notifications as read for the authenticated user.

Authorizations:

jwtTokensecretToken

Request Body schema: application/json
required

status

required

string

Value: "READ"

Responses

Request samples

Payload

Content type

application/json

{"status": "READ"
}

Response samples

200
400
401
403

Content type

application/json

{"success": true
}

Mark notification as read

Mark a specific notification as read for the authenticated user.

Authorizations:

jwtTokensecretToken

path Parameters

notificationId

required

integer [ -9007199254740991 .. 9007199254740991 ]

Request Body schema: application/json
required

status

required

string

Value: "READ"

Responses

Request samples

Payload

Content type

application/json

{"status": "READ"
}

Response samples

200
400
401
403
404

Content type

application/json

null

Email

Email tracking pixel

Email open tracking pixel. Returns a 1x1 transparent GIF and records the open event.

path Parameters

token

required

string <uuid> ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA...

Responses

Member Invites

List member invites

List member invites for an organization, project, or user. Users can only view their own invites unless they are admins.

Authorizations:

jwtTokensecretToken

query Parameters

pageOffset	integer [ 0 .. 9007199254740991 ] The number of items to skip before starting to return results. Must be 0 or greater.
pageSize	integer [ 1 .. 1000 ] The maximum number of items to return. Must be between 1 and 1000.
sortBy	string Enum: "createdAt" "status" "role" The field to sort by
sortDir	string Enum: "asc" "desc" The direction to sort by
status	string Enum: "PENDING" "ACCEPTED" "REJECTED"
orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
userName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the user

Responses

Response samples

200
400
401
403
404

Content type

application/json

{"rows": [{"id": -9007199254740991,
"role": "ADMIN",
"status": "PENDING",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"invitedByUserId": -9007199254740991,
"inviteeUserId": -9007199254740991,
"inviteeEmail": null,
"memberId": -9007199254740991,
"orgId": -9007199254740991,
"projectId": -9007199254740991,
"orgName": null,
"projectName": null,
"userAccountEmail": null,
"userFullName": null,
"userName": null,
"userPersonalOrgId": -9007199254740991
}
],
"rowCount": 0
}

Create member invite

Create a member invite for an organization or project. Only admins can create invites. Notifications or emails are sent to the invited user.

Authorizations:

jwtTokensecretToken

query Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project

Request Body schema: application/json
required

usernameOrEmail required	string [ 1 .. 255 ] characters The username or email of the user to invite
role required	string Enum: "ADMIN" "MEMBER" "VIEWER" The role to assign to the member

Responses

Request samples

Payload

Content type

application/json

{"usernameOrEmail": "string",
"role": "ADMIN"
}

Response samples

201
400
401
403
404

Content type

application/json

{"id": -9007199254740991,
"role": "ADMIN",
"status": "PENDING",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"invitedByUserId": -9007199254740991,
"inviteeUserId": -9007199254740991,
"inviteeEmail": null,
"memberId": -9007199254740991,
"orgId": -9007199254740991,
"projectId": -9007199254740991,
"orgName": null,
"projectName": null,
"userAccountEmail": null,
"userFullName": null,
"userName": null,
"userPersonalOrgId": -9007199254740991
}

Delete member invite

Delete a member invite. Only admins of the organization or project can delete invites.

Authorizations:

jwtTokensecretToken

path Parameters

memberInviteId

required

integer [ -9007199254740991 .. 9007199254740991 ]

Responses

Response samples

204
400
401
403
404

Content type

application/json

{ }

Get member invite

Get a member invite by ID. Users can view their own invites, and admins can view invites for their organizations or projects.

Authorizations:

jwtTokensecretToken

path Parameters

memberInviteId

required

integer [ -9007199254740991 .. 9007199254740991 ]

Responses

Response samples

200
400
401
403
404

Content type

application/json

{"id": -9007199254740991,
"role": "ADMIN",
"status": "PENDING",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"invitedByUserId": -9007199254740991,
"inviteeUserId": -9007199254740991,
"inviteeEmail": null,
"memberId": -9007199254740991,
"orgId": -9007199254740991,
"projectId": -9007199254740991,
"orgName": null,
"projectName": null,
"userAccountEmail": null,
"userFullName": null,
"userName": null,
"userPersonalOrgId": -9007199254740991
}

Respond to member invite

Respond to a member invite by accepting or rejecting it. Only the invited user can respond to their own invites.

Authorizations:

jwtTokensecretToken

path Parameters

memberInviteId

required

integer [ -9007199254740991 .. 9007199254740991 ]

Request Body schema: application/json
required

status

required

string

Enum: "ACCEPT" "REJECT"

Responses

Request samples

Payload

Content type

application/json

{"status": "ACCEPT"
}

Response samples

204
400
401
403
404

Content type

application/json

{ }

Get member invite from token

Get a member invite by invite token. This endpoint is public and used for invite links sent via email.

query Parameters

inviteToken

required

string <= 10240 characters

The JWT token

Responses

Response samples

200
400
401
404

Content type

application/json

{"invite": {"id": -9007199254740991,
"role": "ADMIN",
"status": "PENDING",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"invitedByUserId": -9007199254740991,
"inviteeUserId": -9007199254740991,
"inviteeEmail": null,
"memberId": -9007199254740991,
"orgId": -9007199254740991,
"projectId": -9007199254740991,
"orgName": null,
"projectName": null,
"userAccountEmail": null,
"userFullName": null,
"userName": null,
"userPersonalOrgId": -9007199254740991
},
"targetName": null
}

Respond to member invite token

Respond to a member invite using an invite token by accepting or rejecting it. Used for invite links sent via email. Note: This endpoint intentionally does not verify that the authenticated user's email matches the invite email. This allows users with multiple email addresses to accept invites sent to an email that differs from their registered account email. The token itself serves as the authorization mechanism, having been delivered to the invitee's email address.

Authorizations:

jwtTokensecretToken

query Parameters

inviteToken

required

string <= 10240 characters

The JWT token

Request Body schema: application/json
required

status

required

string

Enum: "ACCEPT" "REJECT"

Responses

Request samples

Payload

Content type

application/json

{"status": "ACCEPT"
}

Response samples

204
400
401
403
404

Content type

application/json

{ }

Members

Remove member

Remove a member from an organization or project. Users can remove themselves, or admins can remove any member.

Authorizations:

jwtTokensecretToken

query Parameters

userName required	string <= 100 characters
orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project

Responses

Response samples

204
400
401
403
404

Content type

application/json

{ }

List members

List members for an organization or project, with optional filtering by role.

Authorizations:

jwtTokensecretToken

query Parameters

pageOffset	integer [ 0 .. 9007199254740991 ] The number of items to skip before starting to return results. Must be 0 or greater.
pageSize	integer [ 1 .. 1000 ] The maximum number of items to return. Must be between 1 and 1000.
sortBy	string Enum: "createdAt" "updatedAt" "role" The field to sort by
sortDir	string Enum: "asc" "desc" The direction to sort by
role	string Enum: "ADMIN" "MEMBER" "VIEWER" Filter by member role
orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project

Responses

Response samples

200
400
401
403
404

Content type

application/json

{"rows": [{"id": -9007199254740991,
"role": "ADMIN",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"userId": -9007199254740991,
"orgId": -9007199254740991,
"projectId": -9007199254740991,
"userName": "string",
"orgName": null,
"projectName": null,
"projectOrgId": -9007199254740991,
"projectOrgName": null
}
],
"rowCount": 0
}

Update member

Update a member role in an organization or project. Only admins or super users can update member roles.

Authorizations:

jwtTokensecretToken

query Parameters

userName required	string <= 100 characters
orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project

Request Body schema: application/json
required

role

required

string

Enum: "ADMIN" "MEMBER" "VIEWER"

Responses

Request samples

Payload

Content type

application/json

{"role": "ADMIN"
}

Response samples

200
400
401
403
404

Content type

application/json

{"id": -9007199254740991,
"role": "ADMIN",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"userId": -9007199254740991,
"orgId": -9007199254740991,
"projectId": -9007199254740991,
"userName": "string",
"orgName": null,
"projectName": null,
"projectOrgId": -9007199254740991,
"projectOrgName": null
}

Service Accounts

List service accounts

List service accounts for an organization or project, with pagination and sorting support.

Authorizations:

jwtTokensecretToken

query Parameters

pageOffset	integer [ 0 .. 9007199254740991 ] The number of items to skip before starting to return results. Must be 0 or greater.
pageSize	integer [ 1 .. 1000 ] The maximum number of items to return. Must be between 1 and 1000.
sortBy	string Enum: "createdAt" "name" The field to sort by
sortDir	string Enum: "asc" "desc" The direction to sort by
orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project

Responses

Response samples

200
400
401
403
404

Content type

application/json

{"rows": [{"id": -9007199254740991,
"name": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"apiTokenCount": 0,
"role": "ADMIN"
}
],
"rowCount": 0
}

Create service account

Create a service account for an organization or project. Only admins can create service accounts.

Authorizations:

jwtTokensecretToken

query Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project

Request Body schema: application/json
required

name required	string [ 1 .. 30 ] characters ^sa- The name of the service account (must start with "sa-")
role required	string Enum: "ADMIN" "MEMBER" "VIEWER" The role to assign to the service account

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"role": "ADMIN"
}

Response samples

200
400
401
403
404

Content type

application/json

{"id": -9007199254740991,
"name": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"apiTokenCount": 0,
"role": "ADMIN"
}

Delete service account

Delete a service account from an organization or project. Only admins can delete service accounts.

Authorizations:

jwtTokensecretToken

path Parameters

serviceAccountName

required

string [ 1 .. 30 ] characters ^sa-

The name of the service account

query Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project

Responses

Response samples

204
400
401
403
404

Content type

application/json

{ }

API Tokens

List API tokens

List API tokens for the organization or project.

Authorizations:

jwtTokensecretToken

query Parameters

pageOffset	integer [ 0 .. 9007199254740991 ] The number of items to skip before starting to return results. Must be 0 or greater.
pageSize	integer [ 1 .. 1000 ] The maximum number of items to return. Must be between 1 and 1000.
sortBy	string Enum: "createdAt" "updatedAt" "name" "lastUsedAt" "usedCount" The field to sort by
sortDir	string Enum: "asc" "desc" The direction to sort by
orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
tokenType	string Enum: "SECRET" "FRONTEND" Filter by token type (SECRET or FRONTEND)

Responses

Response samples

200
400
401
403
404

Content type

application/json

{"rows": [{"id": -9007199254740991,
"name": "string",
"description": "string",
"token": "",
"type": "SECRET",
"domainWhitelist": null,
"lastUsedAt": "2019-08-24T14:15:22Z",
"usedCount": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"userId": -9007199254740991,
"userName": "string"
}
],
"rowCount": 0
}

Create API token

Create an API token for a service account. The API token enables programmatic access to the API on behalf of the service account.

Authorizations:

jwtTokensecretToken

query Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project

Request Body schema: application/json
required

serviceAccountName required	string [ 1 .. 30 ] characters ^sa- The name of the service account
name required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name for the API token
description	string <= 1024 characters Optional description for the token
type required	string Enum: "SECRET" "FRONTEND" Token type: SECRET (server-side) or FRONTEND (browser)
domainWhitelist	string <= 1024 characters ^[a-zA-Z0-9.,\s]+$ Optional comma-separated list of allowed domains (for FRONTEND tokens)

Responses

Request samples

Payload

Content type

application/json

{"serviceAccountName": "string",
"name": "string",
"description": "string",
"type": "SECRET",
"domainWhitelist": "string"
}

Response samples

201
400
401
403
404

Content type

application/json

{"id": -9007199254740991,
"name": "string",
"description": "string",
"token": "",
"type": "SECRET",
"domainWhitelist": null,
"lastUsedAt": "2019-08-24T14:15:22Z",
"usedCount": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"userId": -9007199254740991,
"userName": "string"
}

Delete API token

Delete an API token by name.

Authorizations:

jwtTokensecretToken

path Parameters

apiTokenName

required

string <= 255 characters

The name of the API token to delete

query Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project

Responses

Response samples

204
400
401
403
404

Content type

application/json

{ }

Avatars

Delete avatar

Delete the current avatar for the given organization or project.

Authorizations:

jwtTokensecretToken

query Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project

Responses

Response samples

204
400
401
403
404

Content type

application/json

{ }

Get avatar

Get the current avatar for the given organization or project.

query Parameters

format	string Enum: "jpg" "png" "webp" "avif" The image format to transform to
width	integer ( 0 .. 9007199254740991 ] The width of the resized image
height	integer ( 0 .. 9007199254740991 ] The height of the resized image
quality	integer [ 1 .. 100 ] The quality of the resized image
redirectOnNotFound	string <uri>
cacheKey	string <= 256 characters
orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project

Responses

Upload avatar

Upload a new avatar for the given organization or project.

Authorizations:

jwtTokensecretToken

query Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project

Responses

Response samples

Content type

application/json

{ }

Health

Debug Sentry

Debug endpoint to test Sentry error reporting. This endpoint intentionally throws an error.

Authorizations:

None

Responses

Response samples

204
500

Content type

application/json

{ }

Throw test error

Throw Error

Authorizations:

None

Responses

Response samples

204
400
500

Content type

application/json

{ }

Health check

Health check endpoint

Authorizations:

None

Responses

Response samples

204

Content type

application/json

{ }

Stripe webhook handler

Stripe webhook endpoint for subscription events. Verifies webhook signatures and handles subscription lifecycle events. This is a private endpoint for Stripe webhooks only.

Responses

Response samples

200
400
500

Content type

application/json

{"received": true
}

Files

Get storage file

Redirect to immutable object storage content. GCS negotiates gzip with the downloading client.

path Parameters

oid

required

string^[a-f0-9]{64}$

OID of the storage file

query Parameters

name	string Optional asset name to use in Content-Disposition header

Responses

Response samples

302
400
404
503

Content type

application/json

{"redirectUrl": "string"
}

oEmbed

Get oEmbed data

Get oEmbed data for a URL. Returns structured metadata following the oEmbed specification. Only PUBLIC resources are accessible.

Authorizations:

None

query Parameters

url required	string <uri> The URL to generate oEmbed data for
format required	string Default: "json" Enum: "json" "xml" Response format (only "json" is currently supported)
maxwidth	integer ( 0 .. 9007199254740991 ] Maximum width for embedded content in pixels
maxheight	integer ( 0 .. 9007199254740991 ] Maximum height for embedded content in pixels

Responses

Response samples

200
400
404

Content type

application/json

{"version": "1.0",
"type": "photo",
"provider_name": "string",
"provider_url": "http://example.com",
"url": "http://example.com",
"width": 1,
"height": 1,
"title": "string",
"author_name": "string",
"author_url": "http://example.com",
"thumbnail_url": "http://example.com",
"thumbnail_width": 1,
"thumbnail_height": 1,
"html": "string"
}

Tasks

List all tasks

List all tasks (super user only).

Authorizations:

jwtTokensecretToken

query Parameters

pageOffset	integer [ 0 .. 9007199254740991 ] The number of items to skip before starting to return results. Must be 0 or greater.
pageSize	integer [ 1 .. 1000 ] The maximum number of items to return. Must be between 1 and 1000.
sortBy	string Enum: "createdAt" "taskType" "runner" "latestRunStatus" The field to sort by
sortDir	string Enum: "asc" "desc" The direction to sort by

Responses

Response samples

200
400
401
403

Content type

application/json

{"rows": [{"id": -9007199254740991,
"taskType": "string",
"runner": "string",
"parameters": null,
"createdAt": "2019-08-24T14:15:22Z",
"name": "string",
"targetUrl": null,
"orgName": null,
"projectName": null,
"assetName": null,
"createdByName": "string",
"latestRunStatus": "RUNNING",
"latestRunDuration": null
}
],
"rowCount": 0
}

List project tasks

List tasks for a project. Requires project read access.

Authorizations:

jwtTokensecretToken

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project

query Parameters

pageOffset	integer [ 0 .. 9007199254740991 ] The number of items to skip before starting to return results. Must be 0 or greater.
pageSize	integer [ 1 .. 1000 ] The maximum number of items to return. Must be between 1 and 1000.
sortBy	string Enum: "createdAt" "taskType" "runner" "latestRunStatus" The field to sort by
sortDir	string Enum: "asc" "desc" The direction to sort by

Responses

Response samples

Content type

application/json

{"rows": [{"id": -9007199254740991,
"taskType": "string",
"runner": "string",
"parameters": null,
"createdAt": "2019-08-24T14:15:22Z",
"name": "string",
"targetUrl": null,
"orgName": null,
"projectName": null,
"assetName": null,
"createdByName": "string",
"latestRunStatus": "RUNNING",
"latestRunDuration": null
}
],
"rowCount": 0
}

Create or get project task

Create or get an existing task for the project (async only). If a task with the same type, version, and parameters exists, returns it immediately. Otherwise creates and queues the task.

Authorizations:

jwtTokensecretToken

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project

Request Body schema: application/json
required

taskType required	string Enum: "ANALYZE_ASSET" "WEB_PAGE_SCREENSHOT" "BLEND_THUMBNAIL" "FREECAD_THUMBNAIL" "MATERIAL_THUMBNAIL" "LIGHT_THUMBNAIL" "TRANSFORM_GLTF" "IMAGE_TRANSFORM" "ENVMAP_FORMAT_CONVERT" "BLENDER_MODEL_FORMAT_CONVERT" "FREECAD_EXPORT_MODEL" "FREECAD_EXTRACT_PARAMS" "FREECAD_EXPORT_DRAWING" "BLENDER_EXPORT" "BLENDER_RENDER" "AI_COMMENT_REVIEW" "BLENDER_HEALTH" "CHROMIUM_HEALTH" "FREECAD_HEALTH" "SIMPLE_HEALTH" The task type (name)
name required	string [ 1 .. 255 ] characters Human-readable task name
required	object Task parameters (validated by task type schema)
targetUrl	string <uri> <= 1024 characters Optional target URL

Responses

Request samples

Payload

Content type

application/json

{"taskType": "ANALYZE_ASSET",
"name": "string",
"parameters": {"property1": null,
"property2": null
},
"targetUrl": "http://example.com"
}

Response samples

Content type

application/json

{"task": {"id": -9007199254740991,
"taskType": "string",
"runner": "string",
"parameters": null,
"createdAt": "2019-08-24T14:15:22Z",
"name": "string",
"targetUrl": null,
"orgName": null,
"projectName": null,
"assetName": null,
"createdByName": "string",
"latestRunStatus": "RUNNING",
"latestRunDuration": null
},
"status": "QUEUED",
"results": null
}

Get project task

Get a task by ID. Task must belong to the project. Requires project read access.

Authorizations:

jwtTokensecretToken

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
taskId required	integer ( 0 .. 9007199254740991 ] The task ID

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"id": -9007199254740991,
"taskType": "string",
"runner": "string",
"parameters": null,
"createdAt": "2019-08-24T14:15:22Z",
"name": "string",
"targetUrl": null,
"orgName": null,
"projectName": null,
"assetName": null,
"createdByName": "string",
"latestRunStatus": "RUNNING",
"latestRunDuration": null,
"latestRunResults": { }
}

Task events stream

Stream task lifecycle events (SSE). Supports replay from a per-task sequence number via query or Last-Event-ID, then continues streaming live events.

Authorizations:

jwtTokensecretToken

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
taskId required	integer ( 0 .. 9007199254740991 ] The task ID

query Parameters

sinceSequence

integer [ 0 .. 9007199254740991 ]

Responses

Response samples

200
401
403
404
500

Content type

application/json

"string"

Resubmit project task

Resubmit a task (re-queue for execution). Task must belong to the project. Requires project access.

Authorizations:

jwtTokensecretToken

path Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project
taskId required	integer ( 0 .. 9007199254740991 ] The task ID

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"success": true
}

Webhooks

List webhooks

List webhooks for an org or project scope.

Authorizations:

jwtTokensecretToken

query Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project

Responses

Response samples

200
400
401
403
404

Content type

application/json

{"webhooks": [{"id": 1,
"url": "string",
"events": ["asset.created"
],
"description": null,
"active": true,
"scope": "org",
"orgName": "string",
"projectName": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}

Create webhook

Create a webhook at org or project scope. Secret is returned only on create.

Authorizations:

jwtTokensecretToken

query Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project

Request Body schema: application/json
required

url required	string <uri> <= 1024 characters The URL to deliver webhook events to
events required	Array of strings Items Enum: "asset.created" "asset.deleted" "asset.liked" "asset.moderated" "asset.updated" "comment.liked" "comment.moderated" "comment.new" "comment.updated" "external-auth.approved" "member.added" "member.removed" "notification.new" "org.created" "org.deleted" "org.invite" "org.updated" "product.created" "product.deleted" "product.updated" "project.created" "project.deleted" "project.invite" "project.updated" Event types to subscribe to; empty array subscribes to all events
secret	string [ 16 .. 256 ] characters HMAC signing secret; if omitted, the server generates one
description	string <= 1024 characters Human-readable description of this webhook
active required	boolean Default: true Whether the webhook is active

Responses

Request samples

Payload

Content type

application/json

{"url": "http://example.com",
"events": ["asset.created"
],
"secret": "stringstringstri",
"description": "string",
"active": true
}

Response samples

201
400
401
403
404

Content type

application/json

{"id": 1,
"url": "string",
"events": ["asset.created"
],
"secret": "string",
"description": null,
"active": true,
"scope": "org",
"orgName": "string",
"projectName": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Delete webhook

Delete a webhook by ID.

Authorizations:

jwtTokensecretToken

path Parameters

webhookId

required

integer ( 0 .. 9007199254740991 ]

The numeric ID of the webhook

Responses

Response samples

204
400
401
403
404

Content type

application/json

{ }

Get webhook

Get a webhook by ID.

Authorizations:

jwtTokensecretToken

path Parameters

webhookId

required

integer ( 0 .. 9007199254740991 ]

The numeric ID of the webhook

Responses

Response samples

200
400
401
403
404

Content type

application/json

{"id": 1,
"url": "string",
"events": ["asset.created"
],
"description": null,
"active": true,
"scope": "org",
"orgName": "string",
"projectName": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Update webhook

Update a webhook by ID.

Authorizations:

jwtTokensecretToken

path Parameters

webhookId

required

integer ( 0 .. 9007199254740991 ]

The numeric ID of the webhook

Request Body schema: application/json

url	string <uri> <= 1024 characters The URL to deliver webhook events to
events	Array of strings Items Enum: "asset.created" "asset.deleted" "asset.liked" "asset.moderated" "asset.updated" "comment.liked" "comment.moderated" "comment.new" "comment.updated" "external-auth.approved" "member.added" "member.removed" "notification.new" "org.created" "org.deleted" "org.invite" "org.updated" "product.created" "product.deleted" "product.updated" "project.created" "project.deleted" "project.invite" "project.updated" Event types to subscribe to; empty array subscribes to all events
active	boolean Whether the webhook is active
description	string <= 1024 characters Human-readable description of this webhook
secret	string [ 16 .. 256 ] characters Rotate the HMAC signing secret; new secret replaces the old one

Responses

Request samples

Payload

Content type

application/json

{"url": "http://example.com",
"events": ["asset.created"
],
"active": true,
"description": "string",
"secret": "stringstringstri"
}

Response samples

200
400
401
403
404

Content type

application/json

{"id": 1,
"url": "string",
"events": ["asset.created"
],
"secret": "string",
"description": null,
"active": true,
"scope": "org",
"orgName": "string",
"projectName": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Internal

Deliver webhook (internal)

Internal Cloud Tasks delivery endpoint. Delivers a signed webhook payload to the registered URL. Must be called with a valid Cloud Tasks OIDC token.

Request Body schema: application/json
required

webhookId required	integer ( 0 .. 9007199254740991 ]
deliveryId required	string <uuid> ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA...
eventType required	string
required	object

Responses

Request samples

Payload

Content type

application/json

{"webhookId": 1,
"deliveryId": "73dc828d-801d-4d29-b7e4-e046662a5901",
"eventType": "string",
"payload": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "asset.created",
"timestamp": "2019-08-24T14:15:22Z",
"data": null,
"context": {"orgName": "string",
"projectName": "string"
}
}
}

Response samples

204
400
401
500

Content type

application/json

{ }

List leads

List captured leads globally for super users or for a specific project when authorized.

Authorizations:

jwtTokensecretToken

query Parameters

pageOffset	integer [ 0 .. 9007199254740991 ] The number of items to skip before starting to return results. Must be 0 or greater.
pageSize	integer [ 1 .. 1000 ] The maximum number of items to return. Must be between 1 and 1000.
sortBy	string Enum: "createdAt" "email" "companyName" "companySize" "firstName" "lastName" "orgName" "projectName" The field to sort by
sortDir	string Enum: "asc" "desc" The direction to sort by
searchText	string <= 256 characters
orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project

Responses

Response samples

200
400
401
403
404

Content type

application/json

{"rows": [{"id": -9007199254740991,
"projectId": -9007199254740991,
"orgName": "string",
"projectName": "string",
"firstName": "string",
"lastName": "string",
"email": "[email protected]",
"jobTitle": "string",
"phoneNumber": "string",
"companyName": "string",
"companySize": 1,
"comments": null,
"privacyPolicyConsent": true,
"userId": -9007199254740991,
"ipAddress": null,
"browserAgent": null,
"createdAt": "2019-08-24T14:15:22Z"
}
],
"rowCount": 0
}

Create lead

Submit a project-scoped sales inquiry lead from the contact form

Authorizations:

frontendToken

query Parameters

orgName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the organization
projectName required	string [ 1 .. 30 ] characters ^[a-zA-Z][a-zA-Z0-9](?:-[a-zA-Z0-9]+)$ The name of the project

Request Body schema: application/json
required

firstName	string <= 255 characters
lastName	string <= 255 characters
email required	string <email> ^(?:[A-Za-z0-9_'+\-]+\.)[A-Za-z0-9_'+\-][A-...
jobTitle	string <= 255 characters
phoneNumber	string <= 50 characters
companyName	string <= 255 characters
	number or number or number or number or number or number or number or number or number
comments required	string <= 10240 characters
privacyPolicyConsent	boolean Value: true

Responses

Request samples

Payload

Content type

application/json

{"firstName": "string",
"lastName": "string",
"email": "[email protected]",
"jobTitle": "string",
"phoneNumber": "string",
"companyName": "string",
"companySize": 1,
"comments": "string",
"privacyPolicyConsent": true
}

Response samples

Content type

application/json

{"id": -9007199254740991
}

Land of Assets API (0.0.1)

Auth

OAuth consent

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

OAuth authorize

Authorizations:

query Parameters

Responses

Response samples

Refresh access token

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

OAuth token

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Request login code

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Verify login code

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete refresh token

Authorizations:

path Parameters

Responses

Response samples

Complete signup

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Initiate signup

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Verify signup email

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Handle Google OAuth callback

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Initiate Google OAuth

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Generate passkey authentication options

Authorizations:

Request Body schema: application/json

Responses

Request samples

Response samples

Verify passkey authentication

Authorizations:

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required