Assets

GET /media/v1/libraries/{library_id}/assets

Parameter	Location	Type	Description
library_id	path	string	Library ID
asset_folder	query	string	Organizational folder; does not change public_id. Listing by it matches that level only, not subfolders; an empty string is the root
resource_type	query	image / video / raw	image, video (including audio), or raw; auto applies to uploads only, and listing with auto or any other value returns 400
cursor	query	string	Previous next_cursor
limit	query	integer	1–200 items per page, default 50

Returns: AssetPage.

Response

HTTP 200

Successful response.

application/json

Name	Type	Description
data	array<object>	Assets in this page, ordered by creation time descending.
data[].asset_id	string	Generated asset identifier: 32 lowercase hexadecimal characters, preserved across overwrites.
data[].public_id	string	Delivery identifier unique within this library, used in asset URLs.
data[].display_name	string	Human-readable asset name, independent of its delivery identifier.
data[].asset_folder	string	Organizational folder path; the empty string denotes the root folder.
data[].resource_type	string	Stored media category: image for images, video for video or audio, and raw for other files. Upload also accepts auto for detection.
data[].type	string	Public asset delivery mode; upload is the only supported value.
data[].format	string	Detected file format used as the delivery URL extension.
data[].version	number	Monotonically increasing asset version used in delivery URLs; based on upload time in Unix seconds and advanced on overwrite.
data[].version_id	string	Identifier for this asset version, regenerated on overwrite.
data[].bytes	number	Size of the original source content, in bytes.
data[].etag	string	MD5 digest of the source bytes, as 32 lowercase hexadecimal characters.
data[].width	number	Source image or video width in pixels, when known.
data[].height	number	Source image or video height in pixels, when known.
data[].duration	number	Source audio or video duration in seconds, when known.
data[].pages	number
data[].is_audio	boolean	True for audio-only media, which uses resource_type video.
data[].original_filename	string	Original or overridden source filename with its final extension removed.
data[].tags	array<string>	Labels attached to the asset.
data[].context	object	Custom string metadata; omitted when empty or excluded by the search projection.
data[].created_at	string	Time this asset identity was created, in UTC.
data[].url	string	URL for retrieving this version of the asset’s original content.
data[].secure_url	string	HTTPS delivery URL for this asset version; equal to url.
data[].placeholder	boolean	False because this response represents stored source content.
data[].existing	boolean
data[].processing	object	Progress of understanding and embedding tasks for the asset.
data[].library_id	string	Identifier of the library containing this asset.
data[].sha256	string	SHA-256 digest of the source bytes, as 64 lowercase hexadecimal characters.
data[].status	string	Resource status; active identifies an asset that has not been deleted.
data[].semantic	string	Search-vector status: pending awaits vector generation or reprocessing; ready has searchable vectors; unavailable indicates disabled, unsupported or failed embedding. Existing vectors may still serve searches while reprocessing is pending.
data[].preview	object	Generated video previews, present once preview generation succeeds.
next_cursor	string \| null	Opaque token to pass as cursor to listAssets; null means no further page.

curl -X GET "https://api.deepraxis.ai/media/v1/libraries/${LIBRARY_ID}/assets" \
  -H "Authorization: Bearer $PRAXIS_API_KEY"

HTTP 200

{
  "data": [
    {
      "asset_id": "9dfa312ef9bc4b00816339b598b1152c",
      "public_id": "walk-lib-r1-MDP-1791733789929-tagged",
      "display_name": "walk-lib-r1-MDP-1791733789929-tagged",
      "asset_folder": "",
      "resource_type": "image",
      "type": "upload",
      "format": "png",
      "version": 1791733815,
      "version_id": "26cb8171caa5431b8373ad417fd71e32",
      "bytes": 70,
      "etag": "b357a19c87624c7c4d131aeeb4ae677f",
      "width": 1,
      "height": 1,
      "original_filename": "file",
      "tags": [
        "docs"
      ],
      "processing": {
        "state": "processing",
        "kinds": {
          "embedding": "pending",
          "visual": "running",
          "tagging": "running"
        },
        "updated_at": "2026-10-11T15:50:17.571Z"
      },
      "created_at": "2026-10-11T15:50:15.996Z",
      "url": "https://media-develop.praxisusercontent.com/lib_d3881a2f54a34cd79121b9d659e8378c/image/upload/v1791733815/walk-lib-r1-MDP-1791733789929-tagged.png",
      "secure_url": "https://media-develop.praxisusercontent.com/lib_d3881a2f54a34cd79121b9d659e8378c/image/upload/v1791733815/walk-lib-r1-MDP-1791733789929-tagged.png",
      "placeholder": false,
      "library_id": "lib_d3881a2f54a34cd79121b9d659e8378c",
      "sha256": "497790947d4666760ce38f3c00e852c71fdb66cae849bae8e9ede352719e1581",
      "status": "active",
      "semantic": "pending"
    },
    {
      "asset_id": "85b7ef616a8b4719a41777a036ebc1d2",
      "public_id": "walk-lib-r1-MDP-1791733789929-plain",
      "display_name": "walk-lib-r1-MDP-1791733789929-plain",
      "asset_folder": "",
      "resource_type": "image",
      "type": "upload",
      "format": "png",
      "version": 1791733810,
      "version_id": "fdf3c8cd40c2424d86e8397425a69857",
      "bytes": 70,
      "etag": "b357a19c87624c7c4d131aeeb4ae677f",
      "width": 1,
      "height": 1,
      "original_filename": "file",
      "tags": [
        "docs"
      ],
      "created_at": "2026-10-11T15:50:10.842Z",
      "url": "https://media-develop.praxisusercontent.com/lib_d3881a2f54a34cd79121b9d659e8378c/image/upload/v1791733810/walk-lib-r1-MDP-1791733789929-plain.png",
      "secure_url": "https://media-develop.praxisusercontent.com/lib_d3881a2f54a34cd79121b9d659e8378c/image/upload/v1791733810/walk-lib-r1-MDP-1791733789929-plain.png",
      "placeholder": false,
      "library_id": "lib_d3881a2f54a34cd79121b9d659e8378c",
      "sha256": "497790947d4666760ce38f3c00e852c71fdb66cae849bae8e9ede352719e1581",
      "status": "active",
      "processing": {
        "state": "processing",
        "kinds": {
          "embedding": "pending",
          "visual": "running"
        },
        "updated_at": "2026-10-11T15:50:17.571Z"
      },
      "semantic": "pending"
    }
  ],
  "next_cursor": null
}

Upload asset

POST /media/v1/libraries/{library_id}/assets

Parameter	Location	Type	Description
library_id	path	string	Library ID
X-Unique-Upload-Id	header	string	Stable identifier shared by every chunk of this upload.
Content-Range	header	string	Chunk byte range: bytes start-end/total; total may be -1 until the final chunk.

Field	Type	Required	Description
file	string / string	yes	File bytes, HTTPS URL, data URI, or same-account file_…
public_id	string	no	Asset name in delivery URLs; may contain path segments
public_id_prefix	string	no	Path prefix for public_id; a trailing / is optional and exactly one / separates prefix and ID
display_name	string	no	Display name
asset_folder	string	no	Organizational folder; does not change public_id. Listing by it matches that level only, not subfolders; an empty string is the root
use_filename	boolean	no	Use the file name for public_id
unique_filename	boolean	no	Append a unique suffix
use_filename_as_display_name	boolean	no	Use the file name as display_name
filename_override	string	no	Override the original file name
overwrite	boolean	no	Whether to overwrite a matching public ID
tags	string / string[]	no	Asset tags. Uploads accept a comma-separated string (items trimmed, empty items dropped), an array, or repeated tags fields; PATCH accepts an array only and replaces the whole list
context	string / object	no	Custom text key/value pairs; PATCH replaces the whole map, {} clears it
auto_tagging	number	no	Merge tags meeting the threshold after understanding; 0–1
resource_type	image / video / raw / auto	no	image, video (including audio), or raw; auto applies to uploads only, and listing with auto or any other value returns 400

Response

HTTP 200

Successful response.

application/json

Name	Type	Description
asset_id	string	Generated asset identifier: 32 lowercase hexadecimal characters, preserved across overwrites.
public_id	string	Delivery identifier unique within this library, used in asset URLs.
display_name	string	Human-readable asset name, independent of its delivery identifier.
asset_folder	string	Organizational folder path; the empty string denotes the root folder.
resource_type	string	Stored media category: image for images, video for video or audio, and raw for other files. Upload also accepts auto for detection.
type	string	Public asset delivery mode; upload is the only supported value.
format	string	Detected file format used as the delivery URL extension.
version	number	Monotonically increasing asset version used in delivery URLs; based on upload time in Unix seconds and advanced on overwrite.
version_id	string	Identifier for this asset version, regenerated on overwrite.
bytes	number	Size of the original source content, in bytes.
etag	string	MD5 digest of the source bytes, as 32 lowercase hexadecimal characters.
width	number	Source image or video width in pixels, when known.
height	number	Source image or video height in pixels, when known.
duration	number	Source audio or video duration in seconds, when known.
pages	number
is_audio	boolean	True for audio-only media, which uses resource_type video.
original_filename	string	Original or overridden source filename with its final extension removed.
tags	array<string>	Labels attached to the asset.
context	object	Custom string metadata; omitted when empty or excluded by the search projection.
context.custom	object	Caller-supplied metadata entries with string values.
created_at	string	Time this asset identity was created, in UTC.
url	string	URL for retrieving this version of the asset’s original content.
secure_url	string	HTTPS delivery URL for this asset version; equal to url.
placeholder	boolean	False because this response represents stored source content.
existing	boolean	True when overwrite=false returns the asset already stored under the requested public_id.
processing	object	Processing progress, included when auto_tagging was requested.
processing.state	string
processing.kinds	object	Processing states by kind. tagging is present when auto_tagging was requested and follows visual understanding.
processing.updated_at	string	Time the processing state was last updated, in UTC.
done	boolean	False while more chunks are needed before the asset is complete. / True when the final chunk has completed the asset upload.
upload_id	string	Upload session identifier supplied in X-Unique-Upload-Id; reuse it for subsequent chunks.

curl -X POST "https://api.deepraxis.ai/media/v1/libraries/${LIBRARY_ID}/assets" \
  -H "Authorization: Bearer $PRAXIS_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"file":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg==","public_id":"walk-lib-r1-MDP-1791733789929-tagged","tags":["docs"],"auto_tagging":0.6}'

HTTP 200

{
  "asset_id": "9dfa312ef9bc4b00816339b598b1152c",
  "public_id": "walk-lib-r1-MDP-1791733789929-tagged",
  "display_name": "walk-lib-r1-MDP-1791733789929-tagged",
  "asset_folder": "",
  "resource_type": "image",
  "type": "upload",
  "format": "png",
  "version": 1791733815,
  "version_id": "26cb8171caa5431b8373ad417fd71e32",
  "bytes": 70,
  "etag": "b357a19c87624c7c4d131aeeb4ae677f",
  "width": 1,
  "height": 1,
  "original_filename": "file",
  "tags": [
    "docs"
  ],
  "processing": {
    "state": "pending",
    "kinds": {
      "visual": "pending",
      "embedding": "pending",
      "tagging": "pending"
    },
    "updated_at": "2026-10-11T15:50:15.996Z"
  },
  "created_at": "2026-10-11T15:50:15.996Z",
  "url": "https://media-develop.praxisusercontent.com/lib_d3881a2f54a34cd79121b9d659e8378c/image/upload/v1791733815/walk-lib-r1-MDP-1791733789929-tagged.png",
  "secure_url": "https://media-develop.praxisusercontent.com/lib_d3881a2f54a34cd79121b9d659e8378c/image/upload/v1791733815/walk-lib-r1-MDP-1791733789929-tagged.png",
  "placeholder": false
}

Import file

POST /media/v1/libraries/{library_id}/assets/import

Parameter	Location	Type	Description
library_id	path	string	Library ID

Field	Type	Required	Description
file_id	string	yes	File ID owned by the same account
public_id	string	no	Asset name in delivery URLs; may contain path segments
public_id_prefix	string	no	Path prefix for public_id; a trailing / is optional and exactly one / separates prefix and ID
display_name	string	no	Display name
asset_folder	string	no	Organizational folder; does not change public_id. Listing by it matches that level only, not subfolders; an empty string is the root
use_filename	boolean	no	Use the file name for public_id
unique_filename	boolean	no	Append a unique suffix
use_filename_as_display_name	boolean	no	Use the file name as display_name
filename_override	string	no	Override the original file name
overwrite	boolean	no	Whether to overwrite a matching public ID
tags	string / string[]	no	Asset tags. Uploads accept a comma-separated string (items trimmed, empty items dropped), an array, or repeated tags fields; PATCH accepts an array only and replaces the whole list
context	string / object	no	Custom text key/value pairs; PATCH replaces the whole map, {} clears it
auto_tagging	number	no	Merge tags meeting the threshold after understanding; 0–1
resource_type	image / video / raw / auto	no	image, video (including audio), or raw; auto applies to uploads only, and listing with auto or any other value returns 400

Response

HTTP 200

Successful response.

application/json

Name	Type	Description
asset_id	string	Generated asset identifier: 32 lowercase hexadecimal characters, preserved across overwrites.
public_id	string	Delivery identifier unique within this library, used in asset URLs.
display_name	string	Human-readable asset name, independent of its delivery identifier.
asset_folder	string	Organizational folder path; the empty string denotes the root folder.
resource_type	string	Stored media category: image for images, video for video or audio, and raw for other files. Upload also accepts auto for detection.
type	string	Public asset delivery mode; upload is the only supported value.
format	string	Detected file format used as the delivery URL extension.
version	number	Monotonically increasing asset version used in delivery URLs; based on upload time in Unix seconds and advanced on overwrite.
version_id	string	Identifier for this asset version, regenerated on overwrite.
bytes	number	Size of the original source content, in bytes.
etag	string	MD5 digest of the source bytes, as 32 lowercase hexadecimal characters.
width	number	Source image or video width in pixels, when known.
height	number	Source image or video height in pixels, when known.
duration	number	Source audio or video duration in seconds, when known.
pages	number
is_audio	boolean	True for audio-only media, which uses resource_type video.
original_filename	string	Original or overridden source filename with its final extension removed.
tags	array<string>	Labels attached to the asset.
context	object	Custom string metadata; omitted when empty or excluded by the search projection.
context.custom	object	Caller-supplied metadata entries with string values.
created_at	string	Time this asset identity was created, in UTC.
url	string	URL for retrieving this version of the asset’s original content.
secure_url	string	HTTPS delivery URL for this asset version; equal to url.
placeholder	boolean	False because this response represents stored source content.
existing	boolean
processing	object	Progress of understanding and embedding tasks for the asset.
processing.state	string
processing.kinds	object	Processing states by kind. tagging is present when auto_tagging was requested and follows visual understanding.
processing.updated_at	string	Time the processing state was last updated, in UTC.
library_id	string	Identifier of the library containing this asset.
sha256	string	SHA-256 digest of the source bytes, as 64 lowercase hexadecimal characters.
status	string	Resource status; active identifies an asset that has not been deleted.
semantic	string	Search-vector status: pending awaits vector generation or reprocessing; ready has searchable vectors; unavailable indicates disabled, unsupported or failed embedding. Existing vectors may still serve searches while reprocessing is pending.
preview	object	Generated video previews, present once preview generation succeeds.
preview.poster_url	string	Delivery URL of the video’s first-frame poster.
preview.storyboard	object	Preview sprite sheet with tile dimensions and sample spacing.

Get asset

GET /media/v1/libraries/{library_id}/assets/{asset_id}

Parameter	Location	Type	Description
library_id	path	string	Library ID
asset_id	path	string	Asset ID

Returns: Asset.

Response

HTTP 200

Successful response.

application/json

Name	Type	Description
asset_id	string	Generated asset identifier: 32 lowercase hexadecimal characters, preserved across overwrites.
public_id	string	Delivery identifier unique within this library, used in asset URLs.
display_name	string	Human-readable asset name, independent of its delivery identifier.
asset_folder	string	Organizational folder path; the empty string denotes the root folder.
resource_type	string	Stored media category: image for images, video for video or audio, and raw for other files. Upload also accepts auto for detection.
type	string	Public asset delivery mode; upload is the only supported value.
format	string	Detected file format used as the delivery URL extension.
version	number	Monotonically increasing asset version used in delivery URLs; based on upload time in Unix seconds and advanced on overwrite.
version_id	string	Identifier for this asset version, regenerated on overwrite.
bytes	number	Size of the original source content, in bytes.
etag	string	MD5 digest of the source bytes, as 32 lowercase hexadecimal characters.
width	number	Source image or video width in pixels, when known.
height	number	Source image or video height in pixels, when known.
duration	number	Source audio or video duration in seconds, when known.
pages	number
is_audio	boolean	True for audio-only media, which uses resource_type video.
original_filename	string	Original or overridden source filename with its final extension removed.
tags	array<string>	Labels attached to the asset.
context	object	Custom string metadata; omitted when empty or excluded by the search projection.
context.custom	object	Caller-supplied metadata entries with string values.
created_at	string	Time this asset identity was created, in UTC.
url	string	URL for retrieving this version of the asset’s original content.
secure_url	string	HTTPS delivery URL for this asset version; equal to url.
placeholder	boolean	False because this response represents stored source content.
existing	boolean
processing	object	Progress of understanding and embedding tasks for the asset.
processing.state	string
processing.kinds	object	Processing states by kind. tagging is present when auto_tagging was requested and follows visual understanding.
processing.updated_at	string	Time the processing state was last updated, in UTC.
library_id	string	Identifier of the library containing this asset.
sha256	string	SHA-256 digest of the source bytes, as 64 lowercase hexadecimal characters.
status	string	Resource status; active identifies an asset that has not been deleted.
semantic	string	Search-vector status: pending awaits vector generation or reprocessing; ready has searchable vectors; unavailable indicates disabled, unsupported or failed embedding. Existing vectors may still serve searches while reprocessing is pending.
preview	object	Generated video previews, present once preview generation succeeds.
preview.poster_url	string	Delivery URL of the video’s first-frame poster.
preview.storyboard	object	Preview sprite sheet with tile dimensions and sample spacing.

curl -X GET "https://api.deepraxis.ai/media/v1/libraries/${LIBRARY_ID}/assets/85b7ef616a8b4719a41777a036ebc1d2" \
  -H "Authorization: Bearer $PRAXIS_API_KEY"

HTTP 200

{
  "asset_id": "85b7ef616a8b4719a41777a036ebc1d2",
  "public_id": "walk-lib-r1-MDP-1791733789929-plain",
  "display_name": "walk-lib-r1-MDP-1791733789929-plain",
  "asset_folder": "",
  "resource_type": "image",
  "type": "upload",
  "format": "png",
  "version": 1791733810,
  "version_id": "fdf3c8cd40c2424d86e8397425a69857",
  "bytes": 70,
  "etag": "b357a19c87624c7c4d131aeeb4ae677f",
  "width": 1,
  "height": 1,
  "original_filename": "file",
  "tags": [
    "docs"
  ],
  "created_at": "2026-10-11T15:50:10.842Z",
  "url": "https://media-develop.praxisusercontent.com/lib_d3881a2f54a34cd79121b9d659e8378c/image/upload/v1791733810/walk-lib-r1-MDP-1791733789929-plain.png",
  "secure_url": "https://media-develop.praxisusercontent.com/lib_d3881a2f54a34cd79121b9d659e8378c/image/upload/v1791733810/walk-lib-r1-MDP-1791733789929-plain.png",
  "placeholder": false,
  "library_id": "lib_d3881a2f54a34cd79121b9d659e8378c",
  "sha256": "497790947d4666760ce38f3c00e852c71fdb66cae849bae8e9ede352719e1581",
  "status": "active",
  "processing": {
    "state": "processing",
    "kinds": {
      "embedding": "pending",
      "visual": "running"
    },
    "updated_at": "2026-10-11T15:50:17.571Z"
  },
  "semantic": "pending"
}

Update asset

PATCH /media/v1/libraries/{library_id}/assets/{asset_id}

Parameter	Location	Type	Description
library_id	path	string	Library ID
asset_id	path	string	Asset ID

Field	Type	Required	Description
display_name	string	no	Display name
asset_folder	string	no	Organizational folder; does not change public_id. Listing by it matches that level only, not subfolders; an empty string is the root
tags	string[]	no	Asset tags. Uploads accept a comma-separated string (items trimmed, empty items dropped), an array, or repeated tags fields; PATCH accepts an array only and replaces the whole list
context	object	no	Custom text key/value pairs; PATCH replaces the whole map, {} clears it

Response

HTTP 200

Successful response.

application/json

Name	Type	Description
asset_id	string	Generated asset identifier: 32 lowercase hexadecimal characters, preserved across overwrites.
public_id	string	Delivery identifier unique within this library, used in asset URLs.
display_name	string	Human-readable asset name, independent of its delivery identifier.
asset_folder	string	Organizational folder path; the empty string denotes the root folder.
resource_type	string	Stored media category: image for images, video for video or audio, and raw for other files. Upload also accepts auto for detection.
type	string	Public asset delivery mode; upload is the only supported value.
format	string	Detected file format used as the delivery URL extension.
version	number	Monotonically increasing asset version used in delivery URLs; based on upload time in Unix seconds and advanced on overwrite.
version_id	string	Identifier for this asset version, regenerated on overwrite.
bytes	number	Size of the original source content, in bytes.
etag	string	MD5 digest of the source bytes, as 32 lowercase hexadecimal characters.
width	number	Source image or video width in pixels, when known.
height	number	Source image or video height in pixels, when known.
duration	number	Source audio or video duration in seconds, when known.
pages	number
is_audio	boolean	True for audio-only media, which uses resource_type video.
original_filename	string	Original or overridden source filename with its final extension removed.
tags	array<string>	Labels attached to the asset.
context	object	Custom string metadata; omitted when empty or excluded by the search projection.
context.custom	object	Caller-supplied metadata entries with string values.
created_at	string	Time this asset identity was created, in UTC.
url	string	URL for retrieving this version of the asset’s original content.
secure_url	string	HTTPS delivery URL for this asset version; equal to url.
placeholder	boolean	False because this response represents stored source content.
existing	boolean
processing	object	Progress of understanding and embedding tasks for the asset.
processing.state	string
processing.kinds	object	Processing states by kind. tagging is present when auto_tagging was requested and follows visual understanding.
processing.updated_at	string	Time the processing state was last updated, in UTC.
library_id	string	Identifier of the library containing this asset.
sha256	string	SHA-256 digest of the source bytes, as 64 lowercase hexadecimal characters.
status	string	Resource status; active identifies an asset that has not been deleted.
semantic	string	Search-vector status: pending awaits vector generation or reprocessing; ready has searchable vectors; unavailable indicates disabled, unsupported or failed embedding. Existing vectors may still serve searches while reprocessing is pending.
preview	object	Generated video previews, present once preview generation succeeds.
preview.poster_url	string	Delivery URL of the video’s first-frame poster.
preview.storyboard	object	Preview sprite sheet with tile dimensions and sample spacing.

curl -X PATCH "https://api.deepraxis.ai/media/v1/libraries/${LIBRARY_ID}/assets/85b7ef616a8b4719a41777a036ebc1d2" \
  -H "Authorization: Bearer $PRAXIS_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"display_name":"walk-lib-r1-MDP-1791733789929-plain"}'

HTTP 200

{
  "asset_id": "85b7ef616a8b4719a41777a036ebc1d2",
  "public_id": "walk-lib-r1-MDP-1791733789929-plain",
  "display_name": "walk-lib-r1-MDP-1791733789929-plain",
  "asset_folder": "",
  "resource_type": "image",
  "type": "upload",
  "format": "png",
  "version": 1791733810,
  "version_id": "fdf3c8cd40c2424d86e8397425a69857",
  "bytes": 70,
  "etag": "b357a19c87624c7c4d131aeeb4ae677f",
  "width": 1,
  "height": 1,
  "original_filename": "file",
  "tags": [
    "docs"
  ],
  "created_at": "2026-10-11T15:50:10.842Z",
  "url": "https://media-develop.praxisusercontent.com/lib_d3881a2f54a34cd79121b9d659e8378c/image/upload/v1791733810/walk-lib-r1-MDP-1791733789929-plain.png",
  "secure_url": "https://media-develop.praxisusercontent.com/lib_d3881a2f54a34cd79121b9d659e8378c/image/upload/v1791733810/walk-lib-r1-MDP-1791733789929-plain.png",
  "placeholder": false,
  "library_id": "lib_d3881a2f54a34cd79121b9d659e8378c",
  "sha256": "497790947d4666760ce38f3c00e852c71fdb66cae849bae8e9ede352719e1581",
  "status": "active",
  "processing": {
    "state": "processing",
    "kinds": {
      "embedding": "pending",
      "visual": "running"
    },
    "updated_at": "2026-10-11T15:50:17.571Z"
  },
  "semantic": "pending"
}

Delete asset

DELETE /media/v1/libraries/{library_id}/assets/{asset_id}

Parameter	Location	Type	Description
library_id	path	string	Library ID
asset_id	path	string	Asset ID

Returns: Deleted.

Response

HTTP 200

Successful response.

application/json

Name	Type	Description
deleted	boolean	True once this asset has been removed from the library.

curl -X DELETE "https://api.deepraxis.ai/media/v1/libraries/${LIBRARY_ID}/assets/e5f3de0d8609482d8b351894b133c8cb" \
  -H "Authorization: Bearer $PRAXIS_API_KEY"

HTTP 200

{
  "deleted": true
}

Field	Type	Required	Description
kinds	ProcessingKind[]	no	Processing kinds to force rerun; omit to retry only failed kinds

Allowed kinds are visual, frames, transcript, and embedding. Without kinds, only failed tasks for the current asset version are rerun. Explicit kinds force selected ready, failed, or unsupported tasks back to pending for a rerun. Tasks already pending or running are skipped unchanged; repeated requests do not enqueue duplicate work.

Kinds must apply to the asset type: images have visual and embedding; audio has transcript and embedding; video has frames, visual, transcript, and embedding; raw files have none. When no requested kind applies, the request returns 400 INVALID_PARAMS listing the kinds available for that asset. When some apply, only those are processed and the rest are ignored (the returned Asset has no field naming ignored kinds; check processing.kinds).

Rerunning visual, frames, or transcript immediately supersedes the old results and sets embedding and the asset’s semantic state to pending. The previous vectors keep serving semantic search until the new vectors are written, so the asset does not drop out of results while it is reprocessed; matches in that window may show the asset name instead of the old caption. Reads return only current results by default; use include_superseded=true to inspect history. The request returns the updated Asset immediately; processing completes asynchronously.

curl -X POST "https://api.deepraxis.ai/media/v1/libraries/${LIBRARY_ID}/assets/${ASSET_ID}/reprocess" \
  -H "Authorization: Bearer $PRAXIS_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{}'

Response

HTTP 200

Successful response.

application/json

Name	Type	Description
asset_id	string	Generated asset identifier: 32 lowercase hexadecimal characters, preserved across overwrites.
public_id	string	Delivery identifier unique within this library, used in asset URLs.
display_name	string	Human-readable asset name, independent of its delivery identifier.
asset_folder	string	Organizational folder path; the empty string denotes the root folder.
resource_type	string	Stored media category: image for images, video for video or audio, and raw for other files. Upload also accepts auto for detection.
type	string	Public asset delivery mode; upload is the only supported value.
format	string	Detected file format used as the delivery URL extension.
version	number	Monotonically increasing asset version used in delivery URLs; based on upload time in Unix seconds and advanced on overwrite.
version_id	string	Identifier for this asset version, regenerated on overwrite.
bytes	number	Size of the original source content, in bytes.
etag	string	MD5 digest of the source bytes, as 32 lowercase hexadecimal characters.
width	number	Source image or video width in pixels, when known.
height	number	Source image or video height in pixels, when known.
duration	number	Source audio or video duration in seconds, when known.
pages	number
is_audio	boolean	True for audio-only media, which uses resource_type video.
original_filename	string	Original or overridden source filename with its final extension removed.
tags	array<string>	Labels attached to the asset.
context	object	Custom string metadata; omitted when empty or excluded by the search projection.
context.custom	object	Caller-supplied metadata entries with string values.
created_at	string	Time this asset identity was created, in UTC.
url	string	URL for retrieving this version of the asset’s original content.
secure_url	string	HTTPS delivery URL for this asset version; equal to url.
placeholder	boolean	False because this response represents stored source content.
existing	boolean
processing	object	Progress of understanding and embedding tasks for the asset.
processing.state	string
processing.kinds	object	Processing states by kind. tagging is present when auto_tagging was requested and follows visual understanding.
processing.updated_at	string	Time the processing state was last updated, in UTC.
library_id	string	Identifier of the library containing this asset.
sha256	string	SHA-256 digest of the source bytes, as 64 lowercase hexadecimal characters.
status	string	Resource status; active identifies an asset that has not been deleted.
semantic	string	Search-vector status: pending awaits vector generation or reprocessing; ready has searchable vectors; unavailable indicates disabled, unsupported or failed embedding. Existing vectors may still serve searches while reprocessing is pending.
preview	object	Generated video previews, present once preview generation succeeds.
preview.poster_url	string	Delivery URL of the video’s first-frame poster.
preview.storyboard	object	Preview sprite sheet with tile dimensions and sample spacing.

AssetPage

Field	Type	Required	Description
data	Asset[]	yes	Results in this page
next_cursor	string / null	yes	Next-page cursor; null or absent at the end

CloudinaryResource

Field	Type	Required	Description
asset_id	AssetId	yes	Asset ID
public_id	string	yes	Asset name in delivery URLs; may contain path segments
display_name	string	yes	Display name
asset_folder	string	yes	Organizational folder; does not change public_id. Listing by it matches that level only, not subfolders; an empty string is the root
resource_type	ResourceType	yes	image, video (including audio), or raw; auto applies to uploads only, and listing with auto or any other value returns 400
type	DeliveryType	yes	Resource or event type
format	string	yes	File format
version	number	yes	Delivery version
version_id	string	yes	Version identifier
bytes	number	yes	File size in bytes
etag	string	yes	File checksum
width	number	no	Width in pixels
height	number	no	Height in pixels
duration	number	no	Duration in seconds
pages	number	no	Document pages
is_audio	boolean	no	Whether this is audio
original_filename	string	no	Original file name
tags	string[]	yes	Asset tags. Uploads accept a comma-separated string (items trimmed, empty items dropped), an array, or repeated tags fields; PATCH accepts an array only and replaces the whole list
context	object	no	Custom text key/value pairs; PATCH replaces the whole map, {} clears it
created_at	IsoTimestamp	yes	Creation time
url	string	yes	Original-file URL
secure_url	string	yes	HTTPS delivery URL
placeholder	false	yes	Always false
existing	boolean	no	Whether an existing asset was returned without overwrite
processing	Processing	no	Overall and per-kind processing states

Asset

Field	Type	Required	Description
asset_id	AssetId	yes	Asset ID
public_id	string	yes	Asset name in delivery URLs; may contain path segments
display_name	string	yes	Display name
asset_folder	string	yes	Organizational folder; does not change public_id. Listing by it matches that level only, not subfolders; an empty string is the root
resource_type	ResourceType	yes	image, video (including audio), or raw; auto applies to uploads only, and listing with auto or any other value returns 400
type	DeliveryType	yes	Resource or event type
format	string	yes	File format
version	number	yes	Delivery version
version_id	string	yes	Version identifier
bytes	number	yes	File size in bytes
etag	string	yes	File checksum
width	number	no	Width in pixels
height	number	no	Height in pixels
duration	number	no	Duration in seconds
pages	number	no	Document pages
is_audio	boolean	no	Whether this is audio
original_filename	string	no	Original file name
tags	string[]	yes	Asset tags. Uploads accept a comma-separated string (items trimmed, empty items dropped), an array, or repeated tags fields; PATCH accepts an array only and replaces the whole list
context	object	no	Custom text key/value pairs; PATCH replaces the whole map, {} clears it
created_at	IsoTimestamp	yes	Creation time
url	string	yes	Original-file URL
secure_url	string	yes	HTTPS delivery URL
placeholder	false	yes	Always false
existing	boolean	no	Whether an existing asset was returned without overwrite
processing	Processing	yes	Overall and per-kind processing states
library_id	LibraryId	yes	Library ID
sha256	string	yes	Content checksum
status	"active"	yes	Resource status
semantic	"pending" / "ready" / "unavailable"	yes	Searchable semantically when ready
preview	object	no	Preview poster and storyboard

Deleted

Field	Type	Required	Description
deleted	true	yes	Deletion result

Processing

Field	Type	Required	Description
state	ProcessingState	yes	Overall processing state
kinds	object	yes	Per-kind processing states
updated_at	IsoTimestamp	yes	Update time

Storyboard

Field	Type	Required	Description
url	string	yes	Original-file URL
tiles	number	yes	Storyboard tile count
interval_ms	number	yes	Tile interval in milliseconds
tile_width	number	yes	Tile width
tile_height	number	yes	Tile height

Assets

List assets

Response

HTTP 200

Upload asset

Request body

Response

HTTP 200

Import file

Request body

Response

HTTP 200

Get asset

Response

HTTP 200

Update asset

Request body

Response

HTTP 200

Delete asset

Response

HTTP 200

Reprocess asset

Request body

Response

HTTP 200

AssetPage

CloudinaryResource

Asset

Deleted

Processing

Storyboard

On this page