Kubi Docs
Kubi API

Read and set the screen's clipboard text.


Read the clipboard

GET
https://api.trykubi.com/v1
/screens/{screen_id}/clipboard
Bearer (API key)

Needs the control permission. Answers within 5 s.

The clipboard's text, up to 100,000 characters; truncated says when there was more. Text only: an image or files on the clipboard read as empty. Needs control, since clipboards hold copied passwords. History records the call, never the text read.

Read the clipboard › path Parameters

screen_id
​string · maxLength: 24 · pattern: ^scr_[0-9a-z]{20}$ · required

Screen id (scr_...).

Read the clipboard › Headers

Kubi-Run
​string · maxLength: 100 · pattern: ^[ -~]{1,100}$

Optional label that groups calls into one run in the screen's history. It is only a label and never locks the screen. The SDK fills it from KUBI_RUN, else Claude Code's CLAUDE_CODE_SESSION_ID, else one id per client it creates.

Read the clipboard › Responses

Success.

text
​string · maxLength: 100000 · required

The clipboard's text; empty when it holds none or holds no text.

truncated
​boolean · required

true when the clipboard held more than 100,000 characters and only the first came back.


Set the clipboard

PUT
https://api.trykubi.com/v1
/screens/{screen_id}/clipboard
Bearer (API key)

Needs the control permission. Answers within 5 s.

Puts text on the clipboard, up to 100,000 characters, for the screen's apps to paste; empty clears it. To paste it straight into the focused field, use the type action with via: paste. The text stays until something else copies or the screen restarts. History keeps it as typed text.

Set the clipboard › path Parameters

screen_id
​string · maxLength: 24 · pattern: ^scr_[0-9a-z]{20}$ · required

Screen id (scr_...).

Set the clipboard › Headers

Kubi-Run
​string · maxLength: 100 · pattern: ^[ -~]{1,100}$

Optional label that groups calls into one run in the screen's history. It is only a label and never locks the screen. The SDK fills it from KUBI_RUN, else Claude Code's CLAUDE_CODE_SESSION_ID, else one id per client it creates.

Set the clipboard › Request Body

text
​string · maxLength: 100000 · required

Text to put on the clipboard; empty clears it.

Set the clipboard › Responses

Success.

text
​string · maxLength: 100000 · required

The clipboard's text; empty when it holds none or holds no text.

truncated
​boolean · required

true when the clipboard held more than 100,000 characters and only the first came back.