Menu
Platform
AI
App store purchases
Database
Flags
Generated Assets
Jobs and cron
Localization
Monitoring
Notifications
Payments
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
On this page
Export an asset
Exports every servable variant in the environment as one flat, paged manifest, independent of the keys the code declares.
Exports every servable variant in the environment as one flat, paged manifest, independent of the keys the code declares. Rejected and retired variants are left out unless filter asks for their review_state. The last page carries a digest a client checks to know it holds the whole set.
- Path
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/assets:export - Scope
assets:read - Effect
read— nothing is written. - Collection assets
- Query
page_size,page_token,filter
#Request
| Field | Type | What it is |
|---|---|---|
parent | string | The environment to export from. Required. |
page_size | int32 | At most this many items; default 100, clamped to 1000. |
page_token | string | next_page_token of the previous page. |
filter | string | AIP-160 filter, limited to kind and review_state; for example kind = ASSET_KIND_IMAGE. Without a review_state term, rejected and retired variants are left out. |
#Response
| Field | Type | What it is |
|---|---|---|
items | ExportedAsset[] | The page, oldest variant first. |
next_page_token | string | The token of the next page; empty on the last page. |
manifest_digest | string | On the last page only: sha256: and the hex SHA-256 of the content_hash of every item the filter matches (one line per item, sorted, each ended by a line feed). A client that downloaded every page recomputes it from the items it holds. |
#ExportedAsset
| Field | Type | What it is |
|---|---|---|
asset_key | string | The logical key of the asset the variant belongs to. |
asset_uid | string | The asset's immutable uid. |
kind | AssetKind | What the asset is. One of image, sfx, music, video, character, voice. |
content_hash | string | SHA-256 of the file, 64 lowercase hex characters. |
ext | string | The file extension, without the dot. |
media_type | string | The IANA media type. |
bytes | int64 | The file size in bytes. |
width | int32 | Pixel width. |
height | int32 | Pixel height. |
url | string | The public, content-addressed, immutable download URL. |
review_state | ReviewState | The human review of the variant. Output only. One of unreviewed, approved, rejected, retired. |
approved_by | string | Who approved the variant; empty until approved. |
model | string | The recorded model id; informational. |
seed | string | The seed, an unsigned decimal string. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.INVALID_FIELD— A field failed validation.PAGE_TOKEN_MISMATCH— A page token was reused with different parameters.
Every error arrives in the body Errors describes.
#Examples
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/assets:export" \
-H "Authorization: Bearer $SYLPHX_API_KEY"