enhancedocs
For agentsOpen Enhance ↗
Reference / screen.create

Enhance documentation

screen.create

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

↓ Markdown

screen.create

mutation write

Use when the requested change exactly matches screen.create; read the current state first when a version or identifier may have changed.

Before calling

  • Authenticate as the accountable Enhance person.
  • Use only resource identifiers returned by an earlier capability result or supplied by the person.
  • Reuse clientToken only when retrying this exact mutation input.

Input

Show complete 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"]}

Example

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
}

Result

Returns a typed screen.create result from the Enhance API without transport-specific prose.

  • screenId (required): Returned field screenId.
  • upload (required): Returned field upload.
  • alreadyExists (required): Returned field alreadyExists.
  • state (required): Returned field state.
Show complete result 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}

Example result

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

Recovery

  • BAD_REQUEST: correct the named fields and call again.
  • UNAUTHORIZED: restore Enhance authentication, then retry once.
  • FORBIDDEN or NOT_FOUND: check the supplied resource and selection; do not substitute unrelated content. Ask for corrected access or scope if needed.
  • CONFLICT: read the current resource, merge the intended change, and retry with its version.
  • INTERNAL: run Enhance diagnostics, report the failure, and stop repeating the call.

Continue with

  • Read the affected screen resource to confirm the result.

Versions

Compatibility: 15b91770e06bbd9bea2137bdda7eec5e70de131e4eaefa0ea13898182b62267c.

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