import { Hyperbrowser } from "@hyperbrowser/sdk";
const client = new Hyperbrowser();
const result = await client.sessions.webmcp.start("session-id", {
toolRef: "tool-ref-from-discovery",
input: {}, // Match the selected tool inputSchema.
timeoutSeconds: 300,
});from hyperbrowser import Hyperbrowser
client = Hyperbrowser()
result = client.sessions.webmcp.start("session-id", {
"tool_ref": "tool-ref-from-discovery",
"input": {}, # Match the selected tool input_schema.
"timeout_seconds": 300,
})curl --request POST \
--url https://api.hyperbrowser.ai/api/session/{id}/webmcp/invocations \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"toolRef": "<string>",
"input": {},
"timeoutSeconds": 300
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hyperbrowser.ai/api/session/{id}/webmcp/invocations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'toolRef' => '<string>',
'input' => [
],
'timeoutSeconds' => 300
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hyperbrowser.ai/api/session/{id}/webmcp/invocations"
payload := strings.NewReader("{\n \"toolRef\": \"<string>\",\n \"input\": {},\n \"timeoutSeconds\": 300\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.hyperbrowser.ai/api/session/{id}/webmcp/invocations")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"toolRef\": \"<string>\",\n \"input\": {},\n \"timeoutSeconds\": 300\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperbrowser.ai/api/session/{id}/webmcp/invocations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"toolRef\": \"<string>\",\n \"input\": {},\n \"timeoutSeconds\": 300\n}"
response = http.request(request)
puts response.read_body{
"invocationId": "<string>",
"toolRef": "<string>",
"status": "running",
"cancellationRequested": true,
"createdAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"result": {
"status": "completed",
"outputBytes": 1,
"untrustedContent": true,
"durationMs": 1,
"invocationId": "<string>",
"output": "<unknown>",
"errorText": "<string>",
"outputTruncated": true,
"outputPreview": "<string>"
},
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"message": "<string>",
"error": "<string>",
"code": "<string>",
"invocationId": "<string>"
}{
"message": "<string>",
"error": "<string>",
"code": "<string>",
"invocationId": "<string>"
}{
"message": "<string>",
"error": "<string>",
"code": "<string>",
"invocationId": "<string>"
}{
"message": "<string>",
"error": "<string>",
"code": "<string>",
"invocationId": "<string>"
}{
"message": "<string>",
"error": "<string>",
"code": "<string>",
"invocationId": "<string>"
}{
"message": "<string>",
"error": "<string>",
"code": "<string>",
"invocationId": "<string>"
}{
"message": "<string>",
"error": "<string>",
"code": "<string>",
"invocationId": "<string>"
}{
"message": "<string>",
"error": "<string>",
"code": "<string>",
"invocationId": "<string>"
}{
"message": "<string>",
"error": "<string>",
"code": "<string>",
"invocationId": "<string>"
}{
"message": "<string>",
"error": "<string>",
"code": "<string>",
"invocationId": "<string>"
}Start a WebMCP invocation
Start once and return a handle without waiting for completion.
import { Hyperbrowser } from "@hyperbrowser/sdk";
const client = new Hyperbrowser();
const result = await client.sessions.webmcp.start("session-id", {
toolRef: "tool-ref-from-discovery",
input: {}, // Match the selected tool inputSchema.
timeoutSeconds: 300,
});from hyperbrowser import Hyperbrowser
client = Hyperbrowser()
result = client.sessions.webmcp.start("session-id", {
"tool_ref": "tool-ref-from-discovery",
"input": {}, # Match the selected tool input_schema.
"timeout_seconds": 300,
})curl --request POST \
--url https://api.hyperbrowser.ai/api/session/{id}/webmcp/invocations \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"toolRef": "<string>",
"input": {},
"timeoutSeconds": 300
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hyperbrowser.ai/api/session/{id}/webmcp/invocations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'toolRef' => '<string>',
'input' => [
],
'timeoutSeconds' => 300
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hyperbrowser.ai/api/session/{id}/webmcp/invocations"
payload := strings.NewReader("{\n \"toolRef\": \"<string>\",\n \"input\": {},\n \"timeoutSeconds\": 300\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.hyperbrowser.ai/api/session/{id}/webmcp/invocations")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"toolRef\": \"<string>\",\n \"input\": {},\n \"timeoutSeconds\": 300\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperbrowser.ai/api/session/{id}/webmcp/invocations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"toolRef\": \"<string>\",\n \"input\": {},\n \"timeoutSeconds\": 300\n}"
response = http.request(request)
puts response.read_body{
"invocationId": "<string>",
"toolRef": "<string>",
"status": "running",
"cancellationRequested": true,
"createdAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"result": {
"status": "completed",
"outputBytes": 1,
"untrustedContent": true,
"durationMs": 1,
"invocationId": "<string>",
"output": "<unknown>",
"errorText": "<string>",
"outputTruncated": true,
"outputPreview": "<string>"
},
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"message": "<string>",
"error": "<string>",
"code": "<string>",
"invocationId": "<string>"
}{
"message": "<string>",
"error": "<string>",
"code": "<string>",
"invocationId": "<string>"
}{
"message": "<string>",
"error": "<string>",
"code": "<string>",
"invocationId": "<string>"
}{
"message": "<string>",
"error": "<string>",
"code": "<string>",
"invocationId": "<string>"
}{
"message": "<string>",
"error": "<string>",
"code": "<string>",
"invocationId": "<string>"
}{
"message": "<string>",
"error": "<string>",
"code": "<string>",
"invocationId": "<string>"
}{
"message": "<string>",
"error": "<string>",
"code": "<string>",
"invocationId": "<string>"
}{
"message": "<string>",
"error": "<string>",
"code": "<string>",
"invocationId": "<string>"
}{
"message": "<string>",
"error": "<string>",
"code": "<string>",
"invocationId": "<string>"
}{
"message": "<string>",
"error": "<string>",
"code": "<string>",
"invocationId": "<string>"
}Authorizations
Path Parameters
Session ID.
Body
1 - 4096Arguments matching the tool inputSchema. At most 1 MiB when JSON encoded. Keys are passed through unchanged.
Tool execution budget in seconds. Expiration requests cancellation; it does not guarantee rollback.
1 <= x <= 3600Response
Invocation accepted
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.
^[a-f0-9]{24}$running, awaiting_submission, completed, error, canceled, outcome_unknown Whether cancellation was requested, regardless of the final outcome.
Nominal terminal-result expiry. Results may be evicted earlier.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?