Enhance documentation

enhance-dev screen create

Reserve a signed upload for a captured page and return its screen id.

enhance-dev screen create

enhance-dev screen create [options]

Arguments

This command takes no positional arguments.

Options

Option	Required	Default	Meaning
`--client-token <string>`	Yes	None	Client-minted capture UUID; reuse it when retrying the same screen reservation.
`--is-recording-mark [boolean]`	No	`true`	Defaults to true for recording marks. Use false for an explicit canvas capture that retains recording provenance without adding a recording mark.
`--provenance [value]`	Yes	None	Required origin JSON `{"sourceRecordingId":"UUID","atMs":0}`, or the literal null.
`--route [value]`	Yes	None	Required original page route, or the literal null.
`--page-title [value]`	Yes	None	Required captured page title, or the literal null.
`--viewport [json]`	Yes	None	Viewport JSON, for example `{"width":1440,"height":900}`.
`--bytes <number>`	Yes	None	Exact byte length of the content uploaded through the signed URL.
`--sha256 [string]`	No	None	Optional hex SHA-256 of the screen file; the upload address then accepts only those bytes.
`--json <json>`	No	None	Complete procedure input as JSON; do not combine it with field flags.

Input

This command presents the capability screen.create. It has write effect and single idempotency.

Show complete input JSON Schema

{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"clientToken":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"isRecordingMark":{"default":true,"type":"boolean"},"provenance":{"anyOf":[{"type":"object","properties":{"sourceRecordingId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"atMs":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["sourceRecordingId","atMs"]},{"type":"null"}]},"route":{"anyOf":[{"type":"string"},{"type":"null"}]},"pageTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"viewport":{"type":"object","properties":{"width":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"height":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["width","height"]},"bytes":{"type":"integer","minimum":1,"maximum":9007199254740991},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$"}},"required":["clientToken","provenance","route","pageTitle","viewport","bytes"]}

Output

This command writes JSON records to standard output. Returns a typed screen.create result from the Enhance API without transport-specific prose.

Show complete output JSON Schema

{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"screenId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"upload":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"expiresAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"headers":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}},"required":["url","expiresAt","headers"],"additionalProperties":false},"alreadyExists":{"type":"boolean"},"state":{"type":"string","enum":["pending","stored"]}},"required":["screenId","upload","alreadyExists","state"],"additionalProperties":false}

Examples

enhance-dev screen create --client-token <string> --provenance [value] --route [value] --page-title [value] --viewport [json] --bytes <number>

Show example input

{
 "clientToken": "00000000-0000-4000-8000-000000000010",
 "provenance": {
  "sourceRecordingId": "00000000-0000-4000-8000-000000000010",
  "atMs": 0
 },
 "route": "x",
 "pageTitle": "x",
 "viewport": {
  "width": 1,
  "height": 1
 },
 "bytes": 1
}

Show example output

{
 "screenId": "00000000-0000-4000-8000-000000000010",
 "upload": {
  "url": "https://example.test/path",
  "expiresAt": "2026-08-10T00:00:00.000Z",
  "headers": {}
 },
 "alreadyExists": false,
 "state": "pending"
}

Exit behaviour

Exit code	Meaning
`0`	The command succeeded.
`1`	The command failed for another reason (`INTERNAL`). A write may have an unknown outcome.
`2`	The command line was malformed. Nothing ran.
`3`	The API refused the input (`BAD_REQUEST`).
`4`	The credential is missing or expired (`UNAUTHORIZED`).
`5`	The API refused the request (`FORBIDDEN`, `NOT_FOUND`, `CONFLICT`, `RATE_LIMITED`).
`6`	A batch finished only in part. Retry with the same `--client-token`.

Versions

Minimum tested versions: Enhance CLI and MCP runtime 0.1.40, plugin 1.0.38, Node.js 24. No older floor is published.