Skip to main content
GET
Node.js
See the WebMCP guide for SDK examples and invocation lifecycle details.

Authorizations

x-api-key
string
header
required

Path Parameters

id
string<uuid>
required

Session ID.

invocationId
string
required
Pattern: ^[a-f0-9]{24}$

Query Parameters

waitSeconds
integer
default:0

Maximum wait for completion, in seconds. Returns the current pending state if the wait expires.

Required range: 0 <= x <= 30

Response

Success

Ephemeral, session-local handle. Pending states have no result or error. A terminal handle may contain a result or an error. Lost on receiver restart, session rebind, or browser shutdown. At most 16 active and 64 retained; terminal results expire after 10 minutes and may be evicted sooner.

invocationId
string
required
Pattern: ^[a-f0-9]{24}$
toolRef
string
required
status
enum<string>
required
Available options:
running,
awaiting_submission,
completed,
error,
canceled,
outcome_unknown
cancellationRequested
boolean
required

Whether cancellation was requested, regardless of the final outcome.

createdAt
string<date-time>
required
expiresAt
string<date-time>

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

result
object
error
object