Filesystem Items

Copy Items

Copy items into a directory as a background job; poll GET /fs-items/copy/{job_id}.

post/fs-items/copy

Request

  • Base URL
    https://api.aspect.inc
  • URL
    https://api.aspect.inc/fs-items/copy
  • Auth
    API key in header Authorization

Request body

asset_idsstring[] nullable

List of asset IDs to copy

directory_idsstring[] nullable

List of directory IDs to copy (recursively, including all nested items)

symlink_idsstring[] nullable

List of symlink IDs to copy

destination_directory_idstring uuid required

ID of the destination parent directory

include_commentsboolean

Whether comment threads (comments, reactions, mentions, and their attachments) carry over to the copied assets

include_metadataboolean

Whether metadata values carry over to the copied assets

copy_as_proxyboolean

Copy videos as their stream proxy: the proxy becomes the copied asset's original. Other asset types copy their original.

Response

Successful Response

job_idstring uuid required

ID of the enqueued copy job; poll GET /fs-items/copy/{job_id}

items_totalinteger required

Number of items the job copies: directories, assets, and symlinks

Changes

No recorded changes to this operation across all 1 revision of this API.