Carbon

Model Upload

The model upload resource.

Basehttps://rest.carbon.ms/modelUpload
GET/modelUpload

List model uploads

Retrieve a paginated list of model uploads. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/modelUpload
curl --request GET \
  --url 'https://rest.carbon.ms/modelUpload?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "name": "Example",
    "modelPath": "string",
    "companyId": "xyz789",
    "createdBy": "string",
    "size": 0,
    "autodeskUrn": "string",
    "createdAt": "2026-01-01T00:00:00Z"
  }
]
GET/modelUpload

Retrieve a model upload

Fetch a single model upload by filtering on `id`.

Query parameters

idstring

Match on the model upload's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/modelUpload
curl --request GET \
  --url 'https://rest.carbon.ms/modelUpload?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "modelPath": "string",
  "companyId": "xyz789",
  "createdBy": "string",
  "size": 0,
  "autodeskUrn": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}
POST/modelUpload

Create a model upload

Create a new model upload.

Body parameters

namestring
sizenumber
modelPathstringrequired
autodeskUrnstring
companyIdstringrequired

References company.id

thumbnailPathstring
POSThttps://rest.carbon.ms/modelUpload
curl --request POST \
  --url https://rest.carbon.ms/modelUpload \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example","modelPath":"string","companyId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "modelPath": "string",
  "companyId": "xyz789",
  "createdBy": "string",
  "size": 0,
  "autodeskUrn": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}
PATCH/modelUpload

Update a model upload

Update an existing model upload, matched on `id`.

Body parameters

namestring
sizenumber
modelPathstringrequired
autodeskUrnstring
companyIdstringrequired

References company.id

thumbnailPathstring
PATCHhttps://rest.carbon.ms/modelUpload
curl --request PATCH \
  --url 'https://rest.carbon.ms/modelUpload?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example"}'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "modelPath": "string",
  "companyId": "xyz789",
  "createdBy": "string",
  "size": 0,
  "autodeskUrn": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}
DELETE/modelUpload

Delete a model upload

Delete a model upload, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the model upload to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/modelUpload
curl --request DELETE \
  --url 'https://rest.carbon.ms/modelUpload?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
204 No Content