The Apiera REST API provides programmatic access to the Apiera platform, enabling seamless integration with your existing systems and workflows.
- Bulk transition asset lifecycle
Apiera REST API (1.0.0)
Filter by exact status match.
Filter by exact category match.
Filter by exact creation timestamp.
Filter by minimum creation timestamp.
Filter by maximum creation timestamp.
Filter by exact update timestamp.
Filter by minimum update timestamp.
Filter by maximum update timestamp.
- Mock serverhttps://docs.apiera.io/_mock/openapi/v1/assets
- http://localhost:5281/v1/assets
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.apiera.io/_mock/openapi/v1/assets?status%5Beq%5D=draft&status%5Border%5D=string&category%5Beq%5D=image&category%5Border%5D=string&storageLocation%5Beq%5D=s3&name%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&include%5Bfiles%5D=true' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Successfully retrieved paginated list of assets.
Timestamp when this asset was created.
Timestamp when this asset was last modified.
Timestamp when this asset was removed. Null if not removed.
Timestamp when this asset was archived. Null if not archived.
Current lifecycle status of this asset.
Category classification for this asset.
Collection of custom metadata key-value pairs associated with this asset.
{ "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" }
Category classification for the new asset.
- Mock serverhttps://docs.apiera.io/_mock/openapi/v1/assets
- http://localhost:5281/v1/assets
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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"
}'Asset created successfully.
Timestamp when this asset was created.
Timestamp when this asset was last modified.
Timestamp when this asset was removed. Null if not removed.
Timestamp when this asset was archived. Null if not archived.
Current lifecycle status of this asset.
Category classification for this asset.
Newly created asset starts in draft status
{ "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" }
- Mock serverhttps://docs.apiera.io/_mock/openapi/v1/assets/{assetUuid}
- http://localhost:5281/v1/assets/{assetUuid}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.apiera.io/_mock/openapi/v1/assets/{assetUuid}?include%5Bmetadata%5D=true&include%5Bfiles%5D=true' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Successfully retrieved asset.
Timestamp when this asset was created.
Timestamp when this asset was last modified.
Timestamp when this asset was removed. Null if not removed.
Timestamp when this asset was archived. Null if not archived.
Current lifecycle status of this asset.
Category classification for this asset.
Collection of custom metadata key-value pairs associated with this asset.
{ "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" }
- Mock serverhttps://docs.apiera.io/_mock/openapi/v1/assets/{assetUuid}
- http://localhost:5281/v1/assets/{assetUuid}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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"
}'Asset updated successfully.
Timestamp when this asset was created.
Timestamp when this asset was last modified.
Timestamp when this asset was removed. Null if not removed.
Timestamp when this asset was archived. Null if not archived.
Current lifecycle status of this asset.
Category classification for this asset.
Asset with modified metadata
{ "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" }
- Mock serverhttps://docs.apiera.io/_mock/openapi/v1/assets/{assetUuid}
- http://localhost:5281/v1/assets/{assetUuid}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://docs.apiera.io/_mock/openapi/v1/assets/{assetUuid}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Category classification for the new assets.
- Mock serverhttps://docs.apiera.io/_mock/openapi/v1/assets/bulk
- http://localhost:5281/v1/assets/bulk
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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"
}
]'Assets created successfully.
Timestamp when this asset was created.
Timestamp when this asset was last modified.
Timestamp when this asset was removed. Null if not removed.
Timestamp when this asset was archived. Null if not archived.
Current lifecycle status of this asset.
Category classification for this asset.
Batch creation of different asset types
[ { "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" } ]
- Mock serverhttps://docs.apiera.io/_mock/openapi/v1/assets/bulk
- http://localhost:5281/v1/assets/bulk
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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 '[
{
"assetUuid": "ee6af44a-bc5b-48d8-8594-0296d309de33",
"name": "string",
"description": "string",
"altText": "string"
}
]'Assets updated successfully.
Timestamp when this asset was created.
Timestamp when this asset was last modified.
Timestamp when this asset was removed. Null if not removed.
Timestamp when this asset was archived. Null if not archived.
Current lifecycle status of this asset.
Category classification for this asset.
[ { "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" } ]
- Mock serverhttps://docs.apiera.io/_mock/openapi/v1/assets/{assetUuid}/actions/lifecycle
- http://localhost:5281/v1/assets/{assetUuid}/actions/lifecycle
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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"
}'Asset transitioned successfully.
Timestamp when this asset was created.
Timestamp when this asset was last modified.
Timestamp when this asset was removed. Null if not removed.
Timestamp when this asset was archived. Null if not archived.
Current lifecycle status of this asset.
Category classification for this asset.
{ "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" }
Lifecycle transition to apply to all specified assets.
- Mock serverhttps://docs.apiera.io/_mock/openapi/v1/assets/bulk/actions/lifecycle
- http://localhost:5281/v1/assets/bulk/actions/lifecycle
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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"
]
}'Assets transitioned successfully.
Timestamp when this asset was created.
Timestamp when this asset was last modified.
Timestamp when this asset was removed. Null if not removed.
Timestamp when this asset was archived. Null if not archived.
Current lifecycle status of this asset.
Category classification for this asset.
[ { "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" } ]