docs.vertex3d.com Open in urlscan Pro
54.146.246.120  Public Scan

Form analysis
0 forms found in the DOM

Text Content

 * Body
 * Headers (2)

 * Body
 * Headers (0)

 * Body
 * Headers (1)




Public


Documentation Settings

ENVIRONMENT
No Environment

LAYOUT
Double Column

LANGUAGE
cURL - cURL



Vertex Platform API
Introduction
accounts
applications
batches
files
geometry-sets
hits
oauth2
part-renditions
part-revisions
parts
scene-alterations
scene-annotations
scene-item-overrides
scene-items
scene-synchronizations
scene-views
scenes
scene-view-states
stream-keys
translation-inspections
webhook-subscriptions
exports


VERTEX PLATFORM API

The Vertex distributed cloud rendering platform includes a set of APIs and SDKs,
which together allow easily integrating 3D product data into your business
application.

See our Developer Guides to get started.

Notes about the Postman collection and API Reference code samples:

   

 * They include all required and optional body parameters for completeness.
   Remove any optional parameters as desired.

   

 * They use auto-generated IDs and other values that may share the same value
   for ease of documentation only. In actual requests and responses, the IDs
   should uniquely identify their corresponding resource.
   
   Email: support@vertex3d.com

   


ACCOUNTS




POSTCREATE ACCOUNT


https://platform.vertexvis.com/accounts

Create an account.

BODY PARAMS

Name Type Required Description data CreateAccountRequest_data true ▹ attributes
CreateAccountRequest_data_attributes true ▹▹ name string true ▹ type string true

AUTHORIZATIONOAuth 2.0

HEADERS
Content-Type

application/vnd.api+json

Accept

application/vnd.api+json

Bodyraw (json)
json


{
  "data": {
    "attributes": {
      "name": "<string>"
    },
    "type": "<string>"
  }
}

Example Request
Created

View More
curl


curl --location 'https://platform.vertexvis.com/accounts' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'Authorization: <token>' \
--data '{
  "data": {
    "attributes": {
      "name": "<string>"
    },
    "type": "<string>"
  }
}'

201 Created
Example Response
 * Body
 * Headers (2)

View More
json


{
  "data": {
    "attributes": {
      "created": "<dateTime>",
      "name": "<string>",
      "status": "<string>"
    },
    "id": "<uuid>",
    "type": "<string>"
  },
  "links": {
    "minim0c": {
      "href": "<string>"
    },
    "commodo_6": {
      "href": "<string>"
    }
  }
}

Content-Type

application/vnd.api+json

location



DELETEDELETE ACCOUNT


https://platform.vertexvis.com/accounts/:id

Delete an account.

AUTHORIZATIONOAuth 2.0

HEADERS
Accept

application/vnd.api+json

PATH VARIABLES
id

<uuid>

(Required) The account ID.

Example Request
No Content

curl


curl --location --request DELETE 'https://platform.vertexvis.com/accounts/:id' \
--header 'Authorization: <token>'

204 No Content
Example Response
 * Body
 * Headers (0)

No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers



PATCHUPDATE ACCOUNT


https://platform.vertexvis.com/accounts/:id

Update an account.

BODY PARAMS

Name Type Required Description data UpdateAccountRequest_data true ▹ attributes
UpdateAccountRequest_data_attributes true ▹▹ name string false ▹▹ owner string
false ▹▹ status enum(active, disabled) false ▹ type string true Resource object
type.

AUTHORIZATIONOAuth 2.0

HEADERS
Content-Type

application/vnd.api+json

Accept

application/vnd.api+json

PATH VARIABLES
id

<uuid>

(Required) The account ID.

Bodyraw (json)
json


{
  "data": {
    "attributes": {
      "name": "<string>",
      "owner": "<string>",
      "status": "active"
    },
    "type": "<string>"
  }
}

Example Request
OK

View More
curl


curl --location --request PATCH 'https://platform.vertexvis.com/accounts/:id' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'Authorization: <token>' \
--data '{
  "data": {
    "attributes": {
      "name": "<string>",
      "owner": "<string>",
      "status": "active"
    },
    "type": "<string>"
  }
}'

200 OK
Example Response
 * Body
 * Headers (1)

View More
json


{
  "data": {
    "attributes": {
      "created": "<dateTime>",
      "name": "<string>",
      "status": "<string>"
    },
    "id": "<uuid>",
    "type": "<string>"
  },
  "links": {
    "minim0c": {
      "href": "<string>"
    },
    "commodo_6": {
      "href": "<string>"
    }
  }
}

Content-Type

application/vnd.api+json