Skip to content
API Reference
/
/
Bulk transition asset lif...

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

Tag Contents

Operations

Tags

Operations

Skus

Operations

Sku Dimensions

Operations

Sku Weights

Operations

Family Asset Types

Operations

Family Attributes

Operations

Family Categories

Operations

Families

Operations

Family Relation Types

Operations

Product Assets

Operations

Product Asset Types

Operations

Product Attributes

Operations

Product Categories

Operations

Product Contents

Operations

Products

Operations

Product Metadata

Operations

Product Relations

Operations

Product Relation Types

Operations

Product Tags

Operations

Product Terms

Operations

Organization Members

Operations

Organizations

Operations

Organization Roles

Operations

Locales

Operations

Category Contents

Operations

Categories

Operations

Brand Contents

Operations

Brands

Operations

Attribute Contents

Operations

Attributes

Operations

Attribute Term Contents

Operations

Attribute Terms

Operations

Assets

Operations

List assets

Request

Retrieves a paginated list of assets with optional filtering using bracket notation.

Security
Bearer
Query
uuids[eq]Array of strings(uuid)

Filter by exact uuid match. Supports multiple values.

statuses[eq]Array of strings

Filter by exact status match. Supports multiple values.

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

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

categories[eq]Array of strings

Filter by exact category match. Supports multiple values.

Items Enum"image""video""audio""document""design""archive""data"
category[order]string

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

storageLocations[eq]Array of strings

Filter by exact storage location match. Supports multiple values.

Items Value"s3"
names[eq]Array of strings

Filter by exact name match. Supports multiple values.

name[contains]string

Filter by partial name match.

name[starts]string

Filter by name prefix.

name[ends]string

Filter by name suffix.

name[order]string

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

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.

updatedAt[eq]string(date-time)

Filter by exact update timestamp.

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

Filter by minimum update timestamp.

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

Filter by maximum update timestamp.

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

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

isArchived[eq]boolean

Filter by archived status. Values: true, false.

isRemoved[eq]boolean

Filter by removed status. Values: true, false.

pageinteger(int32)

Page number for pagination. Default is 1.

sizeinteger(int32)

Page size for pagination. Default is 20.

include[metadata]boolean

Include metadata UUIDs. Values: true, false.

expand[metadata]boolean

Expand metadata objects. Values: true, false.

include[files]boolean

Include file UUIDs. Values: true, false.

expand[files]boolean

Expand file objects. Values: true, false.

curl -i -X GET \
  'https://docs.apiera.io/_mock/openapi/v1/assets?uuids%5Beq%5D=497f6eca-6276-4993-bfeb-53cbbbba6f08&statuses%5Beq%5D=draft&status%5Border%5D=string&categories%5Beq%5D=image&category%5Border%5D=string&storageLocations%5Beq%5D=s3&names%5Beq%5D=string&name%5Bcontains%5D=string&name%5Bstarts%5D=string&name%5Bends%5D=string&name%5Border%5D=string&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&updatedAt%5Beq%5D=2025-11-23T14%3A15%3A22.123456Z&updatedAt%5Bmin%5D=2025-11-23T14%3A15%3A22.123456Z&updatedAt%5Bmax%5D=2025-11-23T14%3A15%3A22.123456Z&updatedAt%5Border%5D=string&isArchived%5Beq%5D=true&isRemoved%5Beq%5D=true&page=0&size=0&include%5Bmetadata%5D=true&expand%5Bmetadata%5D=true&include%5Bfiles%5D=true&expand%5Bfiles%5D=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successfully retrieved paginated list of assets.

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

Unique identifier for this asset.

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

Timestamp when this asset was created.

Example: "2025-11-23T14:15:22.123456Z"
items[].​updatedAtstring(date-time)required

Timestamp when this asset was last modified.

Example: "2025-11-23T14:15:22.123456Z"
items[].​removedAtstring or null(date-time)

Timestamp when this asset was removed. Null if not removed.

Example: "2025-11-23T14:15:22.123456Z"
items[].​archivedAtstring or null(date-time)

Timestamp when this asset was archived. Null if not archived.

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

Current lifecycle status of this asset.

Enum"draft""published""unpublished""archived""removed"
items[].​categorystringrequired

Category classification for this asset.

Enum"image""video""audio""document""design""archive""data"
items[].​storageLocationstringrequired

Storage backend where associated files reside.

Value"s3"
items[].​namestring or null

Display name for this asset.

items[].​descriptionstring or null

Optional detailed description for this asset.

items[].​altTextstring or null

Alternative text for accessibility and SEO purposes.

items[].​metadataUuidsArray of strings or null(uuid)

Collection of metadata UUIDs associated with this asset. Populated when include[metadata]=true.

items[].​metadataArray of objects or null(MetadataResponse)

Collection of expanded metadata objects. Populated when expand[metadata]=true.

items[].​fileUuidsArray of strings or null(uuid)

Collection of file UUIDs associated with this asset. Populated when include[files]=true.

items[].​filesArray of objects or null(FileResponse)

Collection of expanded file objects. Populated when expand[files]=true.

paginationobject(PaginationResult)required
pagination.​pageinteger(int32)required
pagination.​sizeinteger(int32)required
pagination.​totalItemsinteger(int32)required
pagination.​totalPagesinteger(int32)required
Response
application/json
{
  "uuid": "234e5678-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-23T15:45:00.000000Z",
  "status": "published",
  "category": "image",
  "storageLocation": "s3",
  "name": "product-lifestyle-shot.jpg",
  "description": "Lifestyle photography showing jacket in outdoor setting",
  "altText": "Person wearing blue winter jacket hiking in mountains"
}

Create asset

Request

Creates a new asset entity. Files must be uploaded separately after creation.

Security
Bearer
Bodyapplication/jsonrequired
categorystringrequired

Category classification for the new asset.

Enum"image""video""audio""document""design""archive""data"
storageLocationstringrequired

Storage backend where associated files will be stored.

Value"s3"
namestring or null[ 1 .. 255 ] characters

Display name for the new asset.

descriptionstring or null<= 1000 characters

Optional detailed description for the new asset.

altTextstring or null<= 500 characters

Optional alternative text for accessibility and SEO purposes.

curl -i -X POST \
  https://docs.apiera.io/_mock/openapi/v1/assets \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "category": "image",
    "storageLocation": "s3",
    "name": "string",
    "description": "string",
    "altText": "string"
  }'

Responses

Asset created successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this asset.

createdAtstring(date-time)required

Timestamp when this asset was created.

Example: "2025-11-23T14:15:22.123456Z"
updatedAtstring(date-time)required

Timestamp when this asset was last modified.

Example: "2025-11-23T14:15:22.123456Z"
removedAtstring or null(date-time)

Timestamp when this asset was removed. Null if not removed.

Example: "2025-11-23T14:15:22.123456Z"
archivedAtstring or null(date-time)

Timestamp when this asset was archived. Null if not archived.

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

Current lifecycle status of this asset.

Enum"draft""published""unpublished""archived""removed"
categorystringrequired

Category classification for this asset.

Enum"image""video""audio""document""design""archive""data"
storageLocationstringrequired

Storage backend where associated files reside.

Value"s3"
namestring or null

Display name for this asset.

descriptionstring or null

Optional detailed description for this asset.

altTextstring or null

Alternative text for accessibility and SEO purposes.

Response
application/json
{
  "uuid": "234e5678-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-23T15:45:00.000000Z",
  "status": "draft",
  "category": "image",
  "storageLocation": "s3",
  "name": "winter-jacket-hero.jpg",
  "description": "Main hero image for product page",
  "altText": "Blue winter jacket on white background"
}

Get asset

Request

Retrieves complete details for a single asset.

Security
Bearer
Path
assetUuidstring(uuid)required

Unique identifier of the asset.

Query
include[metadata]boolean
expand[metadata]boolean
include[files]boolean
expand[files]boolean
curl -i -X GET \
  'https://docs.apiera.io/_mock/openapi/v1/assets/{assetUuid}?include%5Bmetadata%5D=true&expand%5Bmetadata%5D=true&include%5Bfiles%5D=true&expand%5Bfiles%5D=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successfully retrieved asset.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this asset.

createdAtstring(date-time)required

Timestamp when this asset was created.

Example: "2025-11-23T14:15:22.123456Z"
updatedAtstring(date-time)required

Timestamp when this asset was last modified.

Example: "2025-11-23T14:15:22.123456Z"
removedAtstring or null(date-time)

Timestamp when this asset was removed. Null if not removed.

Example: "2025-11-23T14:15:22.123456Z"
archivedAtstring or null(date-time)

Timestamp when this asset was archived. Null if not archived.

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

Current lifecycle status of this asset.

Enum"draft""published""unpublished""archived""removed"
categorystringrequired

Category classification for this asset.

Enum"image""video""audio""document""design""archive""data"
storageLocationstringrequired

Storage backend where associated files reside.

Value"s3"
namestring or null

Display name for this asset.

descriptionstring or null

Optional detailed description for this asset.

altTextstring or null

Alternative text for accessibility and SEO purposes.

metadataUuidsArray of strings or null(uuid)

Collection of metadata UUIDs associated with this asset. Populated when include[metadata]=true.

metadataArray of objects or null(MetadataResponse)

Collection of expanded metadata objects. Populated when expand[metadata]=true.

fileUuidsArray of strings or null(uuid)

Collection of file UUIDs associated with this asset. Populated when include[files]=true.

filesArray of objects or null(FileResponse)

Collection of expanded file objects. Populated when expand[files]=true.

Response
application/json
{
  "uuid": "234e5678-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-23T15:45:00.000000Z",
  "status": "published",
  "category": "image",
  "storageLocation": "s3",
  "name": "product-lifestyle-shot.jpg",
  "description": "Lifestyle photography showing jacket in outdoor setting",
  "altText": "Person wearing blue winter jacket hiking in mountains"
}

Update asset

Request

Updates an existing asset. Only provided fields are updated.

Security
Bearer
Path
assetUuidstring(uuid)required

Unique identifier of the asset.

Bodyapplication/jsonrequired
namestring or null[ 1 .. 255 ] characters

Updated display name for the asset.

descriptionstring or null<= 1000 characters

Updated detailed description for the asset.

altTextstring or null<= 500 characters

Updated alternative text for the asset.

curl -i -X PATCH \
  'https://docs.apiera.io/_mock/openapi/v1/assets/{assetUuid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "description": "string",
    "altText": "string"
  }'

Responses

Asset updated successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this asset.

createdAtstring(date-time)required

Timestamp when this asset was created.

Example: "2025-11-23T14:15:22.123456Z"
updatedAtstring(date-time)required

Timestamp when this asset was last modified.

Example: "2025-11-23T14:15:22.123456Z"
removedAtstring or null(date-time)

Timestamp when this asset was removed. Null if not removed.

Example: "2025-11-23T14:15:22.123456Z"
archivedAtstring or null(date-time)

Timestamp when this asset was archived. Null if not archived.

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

Current lifecycle status of this asset.

Enum"draft""published""unpublished""archived""removed"
categorystringrequired

Category classification for this asset.

Enum"image""video""audio""document""design""archive""data"
storageLocationstringrequired

Storage backend where associated files reside.

Value"s3"
namestring or null

Display name for this asset.

descriptionstring or null

Optional detailed description for this asset.

altTextstring or null

Alternative text for accessibility and SEO purposes.

Response
application/json
{
  "uuid": "234e5678-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-23T15:45:00.000000Z",
  "status": "published",
  "category": "image",
  "storageLocation": "s3",
  "name": "winter-jacket-hero.jpg",
  "description": "Main hero image for product page",
  "altText": "Blue winter jacket on white background"
}

Delete asset

Request

Permanently deletes an asset and all associated files. Cannot be undone.

Security
Bearer
Path
assetUuidstring(uuid)required

Unique identifier of the asset.

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

Responses

Asset deleted successfully.

Response
No content

Bulk create assets

Request

Creates multiple assets in a single atomic operation.

Security
Bearer
Bodyapplication/jsonrequiredArray [
categorystringrequired

Category classification for the new assets.

Enum"image""video""audio""document""design""archive""data"
storageLocationstringrequired

Storage backend where associated files will be stored.

Value"s3"
namestring or null[ 1 .. 255 ] characters

Display name template for the new assets.

descriptionstring or null<= 1000 characters

Optional detailed description for the new assets.

altTextstring or null<= 500 characters

Optional alternative text for the new assets.

]
curl -i -X POST \
  https://docs.apiera.io/_mock/openapi/v1/assets/bulk \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "category": "image",
      "storageLocation": "s3",
      "name": "string",
      "description": "string",
      "altText": "string"
    }
  ]'

Responses

Assets created successfully.

Bodyapplication/jsonArray [
uuidstring(uuid)required

Unique identifier for this asset.

createdAtstring(date-time)required

Timestamp when this asset was created.

Example: "2025-11-23T14:15:22.123456Z"
updatedAtstring(date-time)required

Timestamp when this asset was last modified.

Example: "2025-11-23T14:15:22.123456Z"
removedAtstring or null(date-time)

Timestamp when this asset was removed. Null if not removed.

Example: "2025-11-23T14:15:22.123456Z"
archivedAtstring or null(date-time)

Timestamp when this asset was archived. Null if not archived.

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

Current lifecycle status of this asset.

Enum"draft""published""unpublished""archived""removed"
categorystringrequired

Category classification for this asset.

Enum"image""video""audio""document""design""archive""data"
storageLocationstringrequired

Storage backend where associated files reside.

Value"s3"
namestring or null

Display name for this asset.

descriptionstring or null

Optional detailed description for this asset.

altTextstring or null

Alternative text for accessibility and SEO purposes.

]
Response
application/json
[
  {
    "uuid": "234e5678-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "status": "draft",
    "category": "image",
    "storageLocation": "s3",
    "name": "winter-jacket-hero.jpg",
    "description": "Main hero image for product page",
    "altText": "Blue winter jacket on white background"
  },
  {
    "uuid": "234e5678-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "status": "draft",
    "category": "video",
    "storageLocation": "s3",
    "name": "product-demo.mp4",
    "description": "Product demonstration video",
    "altText": "Video showing product features"
  },
  {
    "uuid": "234e5678-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "status": "draft",
    "category": "document",
    "storageLocation": "s3",
    "name": "care-instructions.pdf",
    "description": "Care and maintenance instructions"
  }
]

Bulk update assets

Request

Updates multiple assets in a single operation.

Security
Bearer
Bodyapplication/jsonrequiredArray [
uuidstring(uuid)required

Identifier of the asset to update.

namestring or null[ 1 .. 255 ] characters

Updated display name for the asset.

descriptionstring or null<= 1000 characters

Updated detailed description for the asset.

altTextstring or null<= 500 characters

Updated alternative text for the asset.

]
curl -i -X PATCH \
  https://docs.apiera.io/_mock/openapi/v1/assets/bulk \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "name": "string",
      "description": "string",
      "altText": "string"
    }
  ]'

Responses

Assets updated successfully.

Bodyapplication/jsonArray [
uuidstring(uuid)required

Unique identifier for this asset.

createdAtstring(date-time)required

Timestamp when this asset was created.

Example: "2025-11-23T14:15:22.123456Z"
updatedAtstring(date-time)required

Timestamp when this asset was last modified.

Example: "2025-11-23T14:15:22.123456Z"
removedAtstring or null(date-time)

Timestamp when this asset was removed. Null if not removed.

Example: "2025-11-23T14:15:22.123456Z"
archivedAtstring or null(date-time)

Timestamp when this asset was archived. Null if not archived.

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

Current lifecycle status of this asset.

Enum"draft""published""unpublished""archived""removed"
categorystringrequired

Category classification for this asset.

Enum"image""video""audio""document""design""archive""data"
storageLocationstringrequired

Storage backend where associated files reside.

Value"s3"
namestring or null

Display name for this asset.

descriptionstring or null

Optional detailed description for this asset.

altTextstring or null

Alternative text for accessibility and SEO purposes.

]
Response
application/json
[
  {
    "uuid": "234e5678-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "status": "published",
    "category": "image",
    "storageLocation": "s3",
    "name": "winter-jacket-hero.jpg",
    "description": "Main hero image for product page",
    "altText": "Blue winter jacket on white background"
  },
  {
    "uuid": "234e5678-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "status": "published",
    "category": "video",
    "storageLocation": "s3",
    "name": "product-demo.mp4",
    "description": "Product demonstration video",
    "altText": "Video showing product features"
  },
  {
    "uuid": "234e5678-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "status": "published",
    "category": "document",
    "storageLocation": "s3",
    "name": "care-instructions.pdf",
    "description": "Care and maintenance instructions"
  }
]

Transition asset lifecycle

Request

Transitions an asset to a different lifecycle state. Valid transitions depend on current status.

Security
Bearer
Path
assetUuidstring(uuid)required

Unique identifier of the asset.

Bodyapplication/jsonrequired
transitionstringrequired

Lifecycle transition to apply to the asset.

Enum"remove""restore""publish""unpublish""archive""unarchive"
curl -i -X PATCH \
  'https://docs.apiera.io/_mock/openapi/v1/assets/{assetUuid}/actions/lifecycle' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "transition": "remove"
  }'

Responses

Asset transitioned successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this asset.

createdAtstring(date-time)required

Timestamp when this asset was created.

Example: "2025-11-23T14:15:22.123456Z"
updatedAtstring(date-time)required

Timestamp when this asset was last modified.

Example: "2025-11-23T14:15:22.123456Z"
removedAtstring or null(date-time)

Timestamp when this asset was removed. Null if not removed.

Example: "2025-11-23T14:15:22.123456Z"
archivedAtstring or null(date-time)

Timestamp when this asset was archived. Null if not archived.

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

Current lifecycle status of this asset.

Enum"draft""published""unpublished""archived""removed"
categorystringrequired

Category classification for this asset.

Enum"image""video""audio""document""design""archive""data"
storageLocationstringrequired

Storage backend where associated files reside.

Value"s3"
namestring or null

Display name for this asset.

descriptionstring or null

Optional detailed description for this asset.

altTextstring or null

Alternative text for accessibility and SEO purposes.

Response
application/json
{
  "uuid": "234e5678-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-23T15:45:00.000000Z",
  "status": "published",
  "category": "image",
  "storageLocation": "s3",
  "name": "winter-jacket-hero.jpg",
  "description": "Main hero image for product page",
  "altText": "Blue winter jacket on white background"
}

Bulk transition asset lifecycle

Request

Transitions multiple assets to a different lifecycle state in a single operation.

Security
Bearer
Bodyapplication/jsonrequired
transitionstringrequired

Lifecycle transition to apply to all specified assets.

Enum"remove""restore""publish""unpublish""archive""unarchive"
uuidsArray of strings(uuid)required

List of asset identifiers to transition.

curl -i -X PATCH \
  https://docs.apiera.io/_mock/openapi/v1/assets/bulk/actions/lifecycle \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "transition": "remove",
    "uuids": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
  }'

Responses

Assets transitioned successfully.

Bodyapplication/jsonArray [
uuidstring(uuid)required

Unique identifier for this asset.

createdAtstring(date-time)required

Timestamp when this asset was created.

Example: "2025-11-23T14:15:22.123456Z"
updatedAtstring(date-time)required

Timestamp when this asset was last modified.

Example: "2025-11-23T14:15:22.123456Z"
removedAtstring or null(date-time)

Timestamp when this asset was removed. Null if not removed.

Example: "2025-11-23T14:15:22.123456Z"
archivedAtstring or null(date-time)

Timestamp when this asset was archived. Null if not archived.

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

Current lifecycle status of this asset.

Enum"draft""published""unpublished""archived""removed"
categorystringrequired

Category classification for this asset.

Enum"image""video""audio""document""design""archive""data"
storageLocationstringrequired

Storage backend where associated files reside.

Value"s3"
namestring or null

Display name for this asset.

descriptionstring or null

Optional detailed description for this asset.

altTextstring or null

Alternative text for accessibility and SEO purposes.

]
Response
application/json
[
  {
    "uuid": "234e5678-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "status": "published",
    "category": "image",
    "storageLocation": "s3",
    "name": "winter-jacket-hero.jpg",
    "description": "Main hero image for product page",
    "altText": "Blue winter jacket on white background"
  },
  {
    "uuid": "234e5678-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "status": "published",
    "category": "video",
    "storageLocation": "s3",
    "name": "product-demo.mp4",
    "description": "Product demonstration video",
    "altText": "Video showing product features"
  },
  {
    "uuid": "234e5678-e89b-12d3-a456-426614174001",
    "createdAt": "2025-11-20T08:15:00.000000Z",
    "updatedAt": "2025-11-23T15:45:00.000000Z",
    "status": "published",
    "category": "document",
    "storageLocation": "s3",
    "name": "care-instructions.pdf",
    "description": "Care and maintenance instructions"
  }
]

Asset Files

Operations

Asset Metadata

Operations
© 2025 Apiera AS