Skip to content
/Asset Files

Apiera REST API (1.0.0)

The Apiera REST API provides programmatic access to the Apiera platform, enabling seamless integration with your existing systems and workflows.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://docs.apiera.io/_mock/openapi/
http://localhost:5281/

Tags

Operations

Skus

Operations

Sku Dimensions

Operations

Sku Weights

Operations

Family Attributes

Operations

Family Categories

Operations

Families

Operations

Organization Members

Operations

Organizations

Operations

Organization Roles

Operations

Categories

Operations

Attributes

Operations

Attribute Terms

Operations

Assets

Operations

Asset Files

Operations

Bulk initiate file uploads

Request

Initiates multiple file uploads in a single operation and returns pre-signed URLs.

Security
Bearer
Bodyapplication/jsonrequiredArray [
assetUuidstring(uuid)required

Identifier of the asset to associate files with.

variationTypestringrequired

Type of file variation being uploaded.

Enum"original""thumbnail""webOptimized""mobileOptimized""productDetail""printReady""socialMedia""videoPoster""videoPreview""videoStreamLow"
storageLocationstringrequired

Storage backend where the file will be stored.

Value"s3"
mimeTypestring<= 255 charactersrequired

MIME type of the file being uploaded.

extensionstring<= 10 charactersrequired

File extension of the file being uploaded.

]
curl -i -X POST \
  https://docs.apiera.io/_mock/openapi/v1/assets/files/bulk/actions/initiate-upload \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "assetUuid": "ee6af44a-bc5b-48d8-8594-0296d309de33",
      "variationType": "original",
      "storageLocation": "s3",
      "mimeType": "string",
      "extension": "string"
    }
  ]'

Responses

Uploads initiated successfully.

Bodyapplication/jsonArray [
uuidstring(uuid)required

Unique identifier for this file.

assetUuidstring(uuid)required

Identifier of the parent asset this file belongs to.

createdAtstring(date-time)required

Timestamp when this file was created.

Example: "2025-11-23T14:15:22.123456Z"
statusstringrequired

Current lifecycle status of this file.

Enum"awaitingUpload""uploaded"
variationTypestringrequired

Type of file variation.

Enum"original""thumbnail""webOptimized""mobileOptimized""productDetail""printReady""socialMedia""videoPoster""videoPreview""videoStreamLow"
storageLocationstringrequired

Storage backend where this file is stored.

Value"s3"
mimeTypestringrequired

MIME type of this file.

extensionstringrequired

File extension of this file.

storageSizeinteger or null(int64)

File size in bytes. Null if not yet calculated.

checksumstringrequired

SHA-256 checksum for file integrity verification.

isAutogeneratedbooleanrequired

Whether this file was automatically generated by the system.

presignedUrlstringrequired

Temporary pre-signed URL for downloading this file.

]
Response
application/json

Batch upload initiation for product images across multiple assets

[
  {
    "uuid": "bbb22222-e89b-12d3-a456-426614174001",
    "assetUuid": "234e5678-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "status": "awaitingUpload",
    "variationType": "original",
    "storageLocation": "s3",
    "mimeType": "image/jpeg",
    "extension": ".jpg",
    "checksum": "",
    "isAutogenerated": false,
    "presignedUrl": "https://bucket.s3.amazonaws.com/assets/234e5678e89b12d3a456426614174001/original.jpg?X-Amz-Signature=..."
  },
  {
    "uuid": "bbb22222-e89b-12d3-a456-426614174002",
    "assetUuid": "234e5678-e89b-12d3-a456-426614174002",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "status": "awaitingUpload",
    "variationType": "original",
    "storageLocation": "s3",
    "mimeType": "image/jpeg",
    "extension": ".jpg",
    "checksum": "",
    "isAutogenerated": false,
    "presignedUrl": "https://bucket.s3.amazonaws.com/assets/234e5678e89b12d3a456426614174002/original.jpg?X-Amz-Signature=..."
  },
  {
    "uuid": "bbb22222-e89b-12d3-a456-426614174003",
    "assetUuid": "234e5678-e89b-12d3-a456-426614174003",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "status": "awaitingUpload",
    "variationType": "original",
    "storageLocation": "s3",
    "mimeType": "image/png",
    "extension": ".png",
    "checksum": "",
    "isAutogenerated": false,
    "presignedUrl": "https://bucket.s3.amazonaws.com/assets/234e5678e89b12d3a456426614174003/original.png?X-Amz-Signature=..."
  }
]

Bulk complete file uploads

Request

Completes multiple file uploads after files have been transferred to storage.

Security
Bearer
Bodyapplication/jsonrequiredArray [
assetUuidstring(uuid)required

Identifier of the asset associated with the file.

fileUuidstring(uuid)required

Identifier of the file to complete.

checksumstring= 64 charactersrequired

SHA-256 checksum of the uploaded file for integrity verification.

]
curl -i -X PATCH \
  https://docs.apiera.io/_mock/openapi/v1/assets/files/bulk/actions/complete-upload \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "assetUuid": "ee6af44a-bc5b-48d8-8594-0296d309de33",
      "fileUuid": "cfc6962f-d401-4825-9c0a-77bccac9ba59",
      "checksum": "stringstringstringstringstringstringstringstringstringstringstri"
    }
  ]'

Responses

Uploads completed successfully.

Bodyapplication/jsonArray [
uuidstring(uuid)required

Unique identifier for this file.

assetUuidstring(uuid)required

Identifier of the parent asset this file belongs to.

createdAtstring(date-time)required

Timestamp when this file was created.

Example: "2025-11-23T14:15:22.123456Z"
statusstringrequired

Current lifecycle status of this file.

Enum"awaitingUpload""uploaded"
variationTypestringrequired

Type of file variation.

Enum"original""thumbnail""webOptimized""mobileOptimized""productDetail""printReady""socialMedia""videoPoster""videoPreview""videoStreamLow"
storageLocationstringrequired

Storage backend where this file is stored.

Value"s3"
mimeTypestringrequired

MIME type of this file.

extensionstringrequired

File extension of this file.

storageSizeinteger or null(int64)

File size in bytes. Null if not yet calculated.

checksumstringrequired

SHA-256 checksum for file integrity verification.

isAutogeneratedbooleanrequired

Whether this file was automatically generated by the system.

presignedUrlstringrequired

Temporary pre-signed URL for downloading this file.

]
Response
application/json

Batch completion with verified checksums and calculated sizes

[
  {
    "uuid": "bbb22222-e89b-12d3-a456-426614174001",
    "assetUuid": "234e5678-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "status": "uploaded",
    "variationType": "original",
    "storageLocation": "s3",
    "mimeType": "image/jpeg",
    "extension": ".jpg",
    "storageSize": 4582912,
    "checksum": "sha256:9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
    "isAutogenerated": false,
    "presignedUrl": "https://bucket.s3.amazonaws.com/assets/234e5678e89b12d3a456426614174001/original.jpg?X-Amz-Signature=..."
  },
  {
    "uuid": "bbb22222-e89b-12d3-a456-426614174002",
    "assetUuid": "234e5678-e89b-12d3-a456-426614174002",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "status": "uploaded",
    "variationType": "original",
    "storageLocation": "s3",
    "mimeType": "image/jpeg",
    "extension": ".jpg",
    "storageSize": 3145728,
    "checksum": "sha256:9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
    "isAutogenerated": false,
    "presignedUrl": "https://bucket.s3.amazonaws.com/assets/234e5678e89b12d3a456426614174002/original.jpg?X-Amz-Signature=..."
  },
  {
    "uuid": "bbb22222-e89b-12d3-a456-426614174003",
    "assetUuid": "234e5678-e89b-12d3-a456-426614174003",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "status": "uploaded",
    "variationType": "original",
    "storageLocation": "s3",
    "mimeType": "image/png",
    "extension": ".png",
    "storageSize": 2097152,
    "checksum": "sha256:9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
    "isAutogenerated": false,
    "presignedUrl": "https://bucket.s3.amazonaws.com/assets/234e5678e89b12d3a456426614174003/original.png?X-Amz-Signature=..."
  }
]

List files

Request

Retrieves a paginated list of files for an asset with optional filtering.

Security
Bearer
Path
assetUuidstring(uuid)required

Unique identifier of the asset.

Query
status[eq]string

Filter by exact status match.

Enum"draft""published""unpublished""archived""removed"
status[order]string

Sort order for status field. Values: asc, desc.

variationType[eq]string

Filter by exact variation type match.

Enum"original""thumbnail""webOptimized""mobileOptimized""productDetail""printReady""socialMedia""videoPoster""videoPreview""videoStreamLow"
variationType[order]string

Sort order for variation type. Values: asc, desc.

mimeType[eq]string

Filter by exact MIME type match.

extension[eq]string

Filter by exact extension match.

extension[contains]string

Filter by partial extension match.

extension[starts]string

Filter by extension prefix.

extension[ends]string

Filter by extension suffix.

isAutogenerated[eq]boolean

Filter by autogenerated status. Values: true, false.

createdAt[eq]string(date-time)

Filter by exact creation timestamp.

Example: createdAt[eq]=2025-11-23T14:15:22.123456Z
createdAt[min]string(date-time)

Filter by minimum creation timestamp.

Example: createdAt[min]=2025-11-23T14:15:22.123456Z
createdAt[max]string(date-time)

Filter by maximum creation timestamp.

Example: createdAt[max]=2025-11-23T14:15:22.123456Z
createdAt[order]string

Sort order for creation timestamp. Values: asc, desc.

storageSize[order]string

Sort order for storage size. Values: asc, desc.

pageinteger(int32)

Page number for pagination. Default is 1.

sizeinteger(int32)

Page size for pagination. Default is 20.

curl -i -X GET \
  'https://docs.apiera.io/_mock/openapi/v1/assets/{assetUuid}/files?status%5Beq%5D=draft&status%5Border%5D=string&variationType%5Beq%5D=original&variationType%5Border%5D=string&mimeType%5Beq%5D=string&extension%5Beq%5D=string&extension%5Bcontains%5D=string&extension%5Bstarts%5D=string&extension%5Bends%5D=string&isAutogenerated%5Beq%5D=true&createdAt%5Beq%5D=2025-11-23T14%3A15%3A22.123456Z&createdAt%5Bmin%5D=2025-11-23T14%3A15%3A22.123456Z&createdAt%5Bmax%5D=2025-11-23T14%3A15%3A22.123456Z&createdAt%5Border%5D=string&storageSize%5Border%5D=string&page=0&size=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successfully retrieved files.

Bodyapplication/json
itemsArray of objects(FileResponse)required
items[].​uuidstring(uuid)required

Unique identifier for this file.

items[].​assetUuidstring(uuid)required

Identifier of the parent asset this file belongs to.

items[].​createdAtstring(date-time)required

Timestamp when this file was created.

Example: "2025-11-23T14:15:22.123456Z"
items[].​statusstringrequired

Current lifecycle status of this file.

Enum"awaitingUpload""uploaded"
items[].​variationTypestringrequired

Type of file variation.

Enum"original""thumbnail""webOptimized""mobileOptimized""productDetail""printReady""socialMedia""videoPoster""videoPreview""videoStreamLow"
items[].​storageLocationstringrequired

Storage backend where this file is stored.

Value"s3"
items[].​mimeTypestringrequired

MIME type of this file.

items[].​extensionstringrequired

File extension of this file.

items[].​storageSizeinteger or null(int64)

File size in bytes. Null if not yet calculated.

items[].​checksumstringrequired

SHA-256 checksum for file integrity verification.

items[].​isAutogeneratedbooleanrequired

Whether this file was automatically generated by the system.

items[].​presignedUrlstringrequired

Temporary pre-signed URL for downloading this file.

paginationobject(PaginationResult)required
pagination.​pageinteger(int32)required
pagination.​sizeinteger(int32)required
pagination.​totalItemsinteger(int32)required
pagination.​totalPagesinteger(int32)required
Response
application/json

Original and generated variations for an image asset

[
  {
    "uuid": "bbb22222-e89b-12d3-a456-426614174001",
    "assetUuid": "234e5678-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "status": "uploaded",
    "variationType": "original",
    "storageLocation": "s3",
    "mimeType": "image/jpeg",
    "extension": ".jpg",
    "storageSize": 4582912,
    "checksum": "sha256:9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
    "isAutogenerated": false,
    "presignedUrl": "https://bucket.s3.amazonaws.com/assets/234e5678e89b12d3a456426614174001/original.jpg?X-Amz-Signature=..."
  },
  {
    "uuid": "bbb22222-e89b-12d3-a456-426614174001",
    "assetUuid": "234e5678-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "status": "uploaded",
    "variationType": "thumbnail",
    "storageLocation": "s3",
    "mimeType": "image/jpeg",
    "extension": ".jpg",
    "storageSize": 45280,
    "checksum": "sha256:9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
    "isAutogenerated": true,
    "presignedUrl": "https://bucket.s3.amazonaws.com/assets/234e5678e89b12d3a456426614174001/thumbnail.jpg?X-Amz-Signature=..."
  },
  {
    "uuid": "bbb22222-e89b-12d3-a456-426614174001",
    "assetUuid": "234e5678-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "status": "uploaded",
    "variationType": "webOptimized",
    "storageLocation": "s3",
    "mimeType": "image/webp",
    "extension": ".webp",
    "storageSize": 285440,
    "checksum": "sha256:9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
    "isAutogenerated": true,
    "presignedUrl": "https://bucket.s3.amazonaws.com/assets/234e5678e89b12d3a456426614174001/weboptimized.webp?X-Amz-Signature=..."
  }
]

Get file

Request

Retrieves complete details for a single file including download URL.

Security
Bearer
Path
assetUuidstring(uuid)required

Unique identifier of the asset.

fileUuidstring(uuid)required

Unique identifier of the file.

curl -i -X GET \
  'https://docs.apiera.io/_mock/openapi/v1/assets/{assetUuid}/files/{fileUuid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successfully retrieved file.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this file.

assetUuidstring(uuid)required

Identifier of the parent asset this file belongs to.

createdAtstring(date-time)required

Timestamp when this file was created.

Example: "2025-11-23T14:15:22.123456Z"
statusstringrequired

Current lifecycle status of this file.

Enum"awaitingUpload""uploaded"
variationTypestringrequired

Type of file variation.

Enum"original""thumbnail""webOptimized""mobileOptimized""productDetail""printReady""socialMedia""videoPoster""videoPreview""videoStreamLow"
storageLocationstringrequired

Storage backend where this file is stored.

Value"s3"
mimeTypestringrequired

MIME type of this file.

extensionstringrequired

File extension of this file.

storageSizeinteger or null(int64)

File size in bytes. Null if not yet calculated.

checksumstringrequired

SHA-256 checksum for file integrity verification.

isAutogeneratedbooleanrequired

Whether this file was automatically generated by the system.

presignedUrlstringrequired

Temporary pre-signed URL for downloading this file.

Response
application/json
{
  "uuid": "bbb22222-e89b-12d3-a456-426614174001",
  "assetUuid": "234e5678-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "status": "uploaded",
  "variationType": "original",
  "storageLocation": "s3",
  "mimeType": "image/jpeg",
  "extension": ".jpg",
  "storageSize": 4582912,
  "checksum": "sha256:9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
  "isAutogenerated": false,
  "presignedUrl": "https://bucket.s3.amazonaws.com/assets/234e5678e89b12d3a456426614174001/original.jpg?X-Amz-Signature=..."
}

Delete file

Request

Permanently deletes a file. Cannot be undone.

Security
Bearer
Path
assetUuidstring(uuid)required

Unique identifier of the asset.

fileUuidstring(uuid)required

Unique identifier of the file.

curl -i -X DELETE \
  'https://docs.apiera.io/_mock/openapi/v1/assets/{assetUuid}/files/{fileUuid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

File deleted successfully.

Response
No content

Initiate file upload

Request

Initiates a file upload and returns a pre-signed URL for uploading.

Security
Bearer
Path
assetUuidstring(uuid)required

Unique identifier of the asset.

Bodyapplication/jsonrequired
variationTypestringrequired

Type of file variation being uploaded.

Enum"original""thumbnail""webOptimized""mobileOptimized""productDetail""printReady""socialMedia""videoPoster""videoPreview""videoStreamLow"
storageLocationstringrequired

Storage backend where the file will be stored.

Value"s3"
mimeTypestring<= 255 charactersrequired

MIME type of the file being uploaded.

extensionstring<= 10 charactersrequired

File extension of the file being uploaded.

curl -i -X POST \
  'https://docs.apiera.io/_mock/openapi/v1/assets/{assetUuid}/files/actions/initiate-upload' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "variationType": "original",
    "storageLocation": "s3",
    "mimeType": "string",
    "extension": "string"
  }'

Responses

Upload initiated successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this file.

assetUuidstring(uuid)required

Identifier of the parent asset this file belongs to.

createdAtstring(date-time)required

Timestamp when this file was created.

Example: "2025-11-23T14:15:22.123456Z"
statusstringrequired

Current lifecycle status of this file.

Enum"awaitingUpload""uploaded"
variationTypestringrequired

Type of file variation.

Enum"original""thumbnail""webOptimized""mobileOptimized""productDetail""printReady""socialMedia""videoPoster""videoPreview""videoStreamLow"
storageLocationstringrequired

Storage backend where this file is stored.

Value"s3"
mimeTypestringrequired

MIME type of this file.

extensionstringrequired

File extension of this file.

storageSizeinteger or null(int64)

File size in bytes. Null if not yet calculated.

checksumstringrequired

SHA-256 checksum for file integrity verification.

isAutogeneratedbooleanrequired

Whether this file was automatically generated by the system.

presignedUrlstringrequired

Temporary pre-signed URL for downloading this file.

Response
application/json

File awaiting upload with pre-signed URL

{
  "uuid": "bbb22222-e89b-12d3-a456-426614174001",
  "assetUuid": "234e5678-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "status": "awaitingUpload",
  "variationType": "original",
  "storageLocation": "s3",
  "mimeType": "image/jpeg",
  "extension": ".jpg",
  "checksum": "",
  "isAutogenerated": false,
  "presignedUrl": "https://bucket.s3.amazonaws.com/assets/234e5678e89b12d3a456426614174001/original.jpg?X-Amz-Signature=..."
}

Complete file upload

Request

Completes a file upload after the file has been transferred to storage.

Security
Bearer
Path
assetUuidstring(uuid)required

Unique identifier of the asset.

fileUuidstring(uuid)required

Unique identifier of the file.

Bodyapplication/jsonrequired
checksumstring= 64 charactersrequired

SHA-256 checksum of the uploaded file for integrity verification.

curl -i -X PATCH \
  'https://docs.apiera.io/_mock/openapi/v1/assets/{assetUuid}/files/{fileUuid}/actions/complete-upload' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "checksum": "stringstringstringstringstringstringstringstringstringstringstri"
  }'

Responses

Upload completed successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this file.

assetUuidstring(uuid)required

Identifier of the parent asset this file belongs to.

createdAtstring(date-time)required

Timestamp when this file was created.

Example: "2025-11-23T14:15:22.123456Z"
statusstringrequired

Current lifecycle status of this file.

Enum"awaitingUpload""uploaded"
variationTypestringrequired

Type of file variation.

Enum"original""thumbnail""webOptimized""mobileOptimized""productDetail""printReady""socialMedia""videoPoster""videoPreview""videoStreamLow"
storageLocationstringrequired

Storage backend where this file is stored.

Value"s3"
mimeTypestringrequired

MIME type of this file.

extensionstringrequired

File extension of this file.

storageSizeinteger or null(int64)

File size in bytes. Null if not yet calculated.

checksumstringrequired

SHA-256 checksum for file integrity verification.

isAutogeneratedbooleanrequired

Whether this file was automatically generated by the system.

presignedUrlstringrequired

Temporary pre-signed URL for downloading this file.

Response
application/json

File with verified checksum and calculated size

{
  "uuid": "bbb22222-e89b-12d3-a456-426614174001",
  "assetUuid": "234e5678-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "status": "uploaded",
  "variationType": "original",
  "storageLocation": "s3",
  "mimeType": "image/jpeg",
  "extension": ".jpg",
  "storageSize": 4582912,
  "checksum": "sha256:9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
  "isAutogenerated": false,
  "presignedUrl": "https://bucket.s3.amazonaws.com/assets/234e5678e89b12d3a456426614174001/original.jpg?X-Amz-Signature=..."
}

Asset Metadata

Operations
© 2025 Apiera AS