---
title: "POST /clipboard/dispatch-file"
method: POST
path: "/clipboard/dispatch-file"
tags: ["clipboard"]
---

# POST /clipboard/dispatch-file

`POST /clipboard/dispatch-file`

## Request

- The document declares no server URL.
- Auth: one of:
  - API key in query parameter `auth`
  - API key in header `Authorization`

Registers a local regular file with the daemon-owned host adapter and asks
the shared engine to dispatch it. The source path is transient input only.

## Request body

- DispatchFileRequest: Request body for `POST /clipboard/dispatch-file`. The path is consumed only by the authenticated local daemon and must never be logged or persisted as clipboard metadata.
  - `peers` string[], nullable
  - `sourcePath` string, required

## Response `200`

Initial file dispatch outcome

- DispatchFileOutcomeResponse: Initial file dispatch result. Delivery may still be pending while peers fetch the bytes; callers use `entry_id` to query the delivery view.
  - `atMs` integer, required
  - `entryId` string, required
  - `perTarget` PerTargetOutcomeDto[], required
    - `deviceId` string, required
    - `error` string, nullable
    - `outcome` string, required: `"accepted"` | `"duplicate"` | `"error"`.
  - `snapshotHash` string, required
  - `totalAccepted` integer, required
  - `totalDuplicate` integer, required
  - `totalErrored` integer, required
  - `totalOffline` integer, required
  - `totalPending` integer, required

## Other responses

- `400`: Invalid or unavailable file
- `500`: Internal server error
- `503`: Daemon is draining

## Changes

- **2026-10-15** `4c664cabd0c5`: 3 info
  - added the optional property `requestId` to the response with the `400` status
  - added the optional property `requestId` to the response with the `500` status
  - added the optional property `requestId` to the response with the `503` status
- **2026-09-20** `f3aa40dcabc4`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/uniclipboard/apis/uniclipboard-daemon-api/changes/clipboard/dispatch-file/post.md)

---

[API](https://skmtc.dev/uniclipboard/apis/uniclipboard-daemon-api.md) - [All operations](https://skmtc.dev/uniclipboard/apis/uniclipboard-daemon-api/llms.txt) - [OpenAPI document](https://skmtc.dev/uniclipboard/apis/uniclipboard-daemon-api/revisions/48a01cf04e4c?raw)
