Signing out…

Documentation

API · Assets

Get an asset

Retrieve an asset and refresh its temporary download URL.

Authentication and limits

Use a Platform Bearer API key with models:generate permission. Assets belong to the key’s workspace. Maximum file size is 20 MiB; audio and video must be at most 300 seconds. Model-specific input limits still apply. Image inputs accept PNG/JPEG/WebP. Seedance requires 300–6000 px per side and aspect ratio 0.4–2.5; MiniMax H3 requires 256–5760 px per side and aspect ratio 0.4–2.5; Wan 3.0 requires 240–8000 px per side, longest/shortest side at most 8, no PNG alpha channel, and at most 20,000,000 bytes. Model-specific checks run before quoting, even for an existing Asset. See the model parameter table for all limits. Uploads and imports do not reserve generation funds. The workspace upload allowance is 100 assets or 1 GiB in a rolling 24-hour window. Read operations do not consume that allowance.

Input schema

GET /api/v1/media/files/{id}. The asset must belong to the API key’s workspace.

ParameterRequiredTypeDefault / optionsDescription
idYesstring—26-character asset ID from upload, import or list.
curl "https://platform-backend.topview.ai/api/v1/media/files/ASSET_ID" -H "Authorization: Bearer $TOPVIEW_API_PLATFORM_KEY"

Output schema

Upload, import and get return the asset inside data. Additional metadata may be present.

FieldTypeDescription
data.idstringAsset ID; save it to retrieve the asset later.
data.kindstringimage, video or audio.
data.content_typestringDetected media MIME type.
data.sizeintegerFile size in bytes (also returned as byte_size).
data.referencestringWorkspace-owned pfmedia:ID reference.
data.download_urlstringTemporary signed HTTPS URL. Retrieve the asset again to refresh it.
data.display_namestring | nullDisplay name; uploaded files use their filename.
{
  "data": {
    "id": "ASSET_ID",
    "kind": "image",
    "content_type": "image/png",
    "size": 12345,
    "reference": "pfmedia:ASSET_ID",
    "download_url": "https://media.example.com/signed-image.png",
    "display_name": "reference.png"
  }
}

Errors and deleted assets

MEDIA_NOT_FOUND (404) means the asset is not available in this workspace. MEDIA_DELETED (410) means it was deleted and must be replaced before new use. Console deletion hides the asset and blocks new use; it does not immediately revoke previously issued URLs or erase snapshots of submitted tasks.

Find model docs