TrellisDevelopers
API reference

Media

List uploaded media assets

GET
/media/assets

Query Parameters

locationId?string
kind?||||||
linkedEntityType?string
linkedEntityId?string
status?|||

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

application/json

curl -X GET "https://example.com/media/assets" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
[  {    "id": "string",    "tenantId": "string",    "locationId": "string",    "kind": "product_image",    "provider": "cloudflare_images",    "providerAssetId": "string",    "uploadUrl": "string",    "publicUrl": "string",    "variants": {      "property1": "string",      "property2": "string"    },    "status": "draft",    "filename": "string",    "mimeType": "string",    "width": 1,    "height": 1,    "sizeBytes": 0,    "checksum": "string",    "linkedEntityType": "string",    "linkedEntityId": "string",    "role": "string",    "metadata": {      "property1": null,      "property2": null    },    "createdByStaffUserId": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }]

Reuse an active shared image without uploading the binary again

POST
/media/assets/{id}/reuse

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/media/assets/string/reuse" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{    "locationId": "string",    "linkedEntityType": "restaurant_branding",    "linkedEntityId": "string",    "role": "gallery_image"  }'
{  "id": "string",  "tenantId": "string",  "locationId": "string",  "kind": "product_image",  "provider": "cloudflare_images",  "providerAssetId": "string",  "uploadUrl": "string",  "publicUrl": "string",  "variants": {    "property1": "string",    "property2": "string"  },  "status": "draft",  "filename": "string",  "mimeType": "string",  "width": 1,  "height": 1,  "sizeBytes": 0,  "checksum": "string",  "linkedEntityType": "string",  "linkedEntityId": "string",  "role": "string",  "metadata": {    "property1": null,    "property2": null  },  "createdByStaffUserId": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Create a Cloudflare Images direct upload session

POST
/media/uploads/direct

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/media/uploads/direct" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{    "kind": "product_image"  }'
{  "asset": {    "id": "string",    "tenantId": "string",    "locationId": "string",    "kind": "product_image",    "provider": "cloudflare_images",    "providerAssetId": "string",    "uploadUrl": "string",    "publicUrl": "string",    "variants": {      "property1": "string",      "property2": "string"    },    "status": "draft",    "filename": "string",    "mimeType": "string",    "width": 1,    "height": 1,    "sizeBytes": 0,    "checksum": "string",    "linkedEntityType": "string",    "linkedEntityId": "string",    "role": "string",    "metadata": {      "property1": null,      "property2": null    },    "createdByStaffUserId": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  },  "uploadUrl": "string",  "expiresAt": "2019-08-24T14:15:22Z"}

Mark a direct-uploaded media asset as uploaded

POST
/media/assets/{id}/complete

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/media/assets/string/complete" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "tenantId": "string",  "locationId": "string",  "kind": "product_image",  "provider": "cloudflare_images",  "providerAssetId": "string",  "uploadUrl": "string",  "publicUrl": "string",  "variants": {    "property1": "string",    "property2": "string"  },  "status": "draft",  "filename": "string",  "mimeType": "string",  "width": 1,  "height": 1,  "sizeBytes": 0,  "checksum": "string",  "linkedEntityType": "string",  "linkedEntityId": "string",  "role": "string",  "metadata": {    "property1": null,    "property2": null  },  "createdByStaffUserId": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Attach a media asset to a product, menu, restaurant branding slot, or floor layout

POST
/media/assets/{id}/attach

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/media/assets/string/attach" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{    "entityType": "product",    "entityId": "string",    "role": "primary_image"  }'
{  "id": "string",  "tenantId": "string",  "locationId": "string",  "kind": "product_image",  "provider": "cloudflare_images",  "providerAssetId": "string",  "uploadUrl": "string",  "publicUrl": "string",  "variants": {    "property1": "string",    "property2": "string"  },  "status": "draft",  "filename": "string",  "mimeType": "string",  "width": 1,  "height": 1,  "sizeBytes": 0,  "checksum": "string",  "linkedEntityType": "string",  "linkedEntityId": "string",  "role": "string",  "metadata": {    "property1": null,    "property2": null  },  "createdByStaffUserId": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Remove a media asset from active use

DELETE
/media/assets/{id}

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

curl -X DELETE "https://example.com/media/assets/string" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
Empty

Restore an archived media asset to active use

POST
/media/assets/{id}/restore

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

application/json

curl -X POST "https://example.com/media/assets/string/restore" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
{  "id": "string",  "tenantId": "string",  "locationId": "string",  "kind": "product_image",  "provider": "cloudflare_images",  "providerAssetId": "string",  "uploadUrl": "string",  "publicUrl": "string",  "variants": {    "property1": "string",    "property2": "string"  },  "status": "draft",  "filename": "string",  "mimeType": "string",  "width": 1,  "height": 1,  "sizeBytes": 0,  "checksum": "string",  "linkedEntityType": "string",  "linkedEntityId": "string",  "role": "string",  "metadata": {    "property1": null,    "property2": null  },  "createdByStaffUserId": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Tables

Previous Page

Notes

Next Page