HYhyperbrowser

Start a WebMCP invocation

Changed on

Start once and return a handle without waiting for completion. Acceptance does not guarantee success; inspect the handle later. A lost response may mean losing the handle to a tool that already acted. Do not blindly retry. Requires an active session created with enableWebMcp: true and an API key with browser.sessions.update permission.

post/api/session/{id}/webmcp/invocations

Request

Path parameters

idstring uuid required

Session ID.

Request body

toolRefstring required
inputobject

Arguments matching the tool inputSchema. At most 1 MiB when JSON encoded. Keys are passed through unchanged.

timeoutSecondsinteger

Tool execution budget in seconds. Expiration requests cancellation; it does not guarantee rollback.

Response

Invocation accepted

invocationIdstring required
toolRefstring required
status'running' | 'awaiting_submission' | 'completed' | 'error' | 'canceled' | 'outcome_unknown' required
cancellationRequestedboolean required

Whether cancellation was requested, regardless of the final outcome.

createdAtstring date-time required
expiresAtstring date-time

Nominal terminal-result expiry. Results may be evicted earlier.

Changes