enhancedocs
For agentsOpen Enhance ↗
Reference / screen.complete

Enhance documentation

screen.complete

Confirm a captured page after its bytes have been uploaded.

↓ Markdown

screen.complete

mutation write

Use when the requested change exactly matches screen.complete; 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":{"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)$"},"etag":{"type":"string","minLength":1,"maxLength":200}},"required":["screenId","etag"]}

Example

Show example input
{
 "screenId": "00000000-0000-4000-8000-000000000010",
 "etag": "x"
}

Result

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

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.

Compatibility: 294fc8db914b5a95f0d0467fc08b766c0b3baef3500b15bd3fd38b855ad20496.