VocalDocscontracts 1.65.0

CaptureWindowCreateRequest

Opens a capture window on the Agent of the path (1.57.0). Refused with 403 capture_not_allowed when the Compliance profile's verbose_capture forbids verbose capture in the window's environment, and with 404 not_found for an agent_version the Agent has not published.

An object with 6 fields.

Fields

FieldTypeRequiredDescription
agent_versionintegernoOnly Calls pinned to this published version; every version of the Agent when absent.
duration_minutesintegernoHow long the window stays open: 1 to 1,440 minutes (24 hours, a target), 60 when absent.
environmentEnvironmentyesThe environment whose Calls the window captures. A developer opens test windows only (forbidden, detail owner_or_admin_required); from 1.58.0 the contracts state that an API key opens one in its own environment only (forbidden, detail environment_not_grantable), as it starts Calls there.
max_callsintegernoThe most Calls the window captures: 1 to 200 (a target), 200 when absent.
reasonstringyesWhy the window is opened, for the access review: free text, stored as a content pair and scrubbed at retention_days.
starts_atRequestTimestampnoWhen the window starts; now when absent. An instant in the past is now.

Used by

The operations whose parameters, request body or responses name this shape directly.