Skip to main content
POST
Copy Items

Authorizations

Authorization
string
header
required

Aspect API key (sk_...) in Authorization header. 'Bearer ' optional.

Body

application/json

API request schema for copying filesystem items into a destination directory.

Copying is asynchronous: the endpoint enqueues a copy job and returns its job id, which can be polled via GET /jobs/{job_id}.

destination_directory_id
string<uuid>
required

ID of the destination parent directory

asset_ids
string<uuid>[] | null

List of asset IDs to copy

directory_ids
string<uuid>[] | null

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

List of symlink IDs to copy

include_comments
boolean
default:true

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

include_metadata
boolean
default:true

Whether metadata values carry over to the copied assets

copy_as_proxy
boolean
default:false

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

Response

Successful Response

API response schema for an enqueued copy job

job_id
string<uuid>
required

ID of the enqueued copy job; poll GET /jobs/{job_id}

items_total
integer
required

Total number of items (directories, assets, symlinks) the job will copy