Get an Invocation

GET /v1/functions/invocations/{id}

Get an Invocation

cURL

curl --request GET \
  --url https://api.browserbase.com/v1/functions/invocations/{id} \
  --header 'X-BB-API-Key: <api-key>'

import requests

url = "https://api.browserbase.com/v1/functions/invocations/{id}"

headers = {"X-BB-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-BB-API-Key': '<api-key>'}};

fetch('https://api.browserbase.com/v1/functions/invocations/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.browserbase.com/v1/functions/invocations/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-BB-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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.browserbase.com/v1/functions/invocations/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-BB-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.browserbase.com/v1/functions/invocations/{id}")
  .header("X-BB-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.browserbase.com/v1/functions/invocations/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-BB-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "functionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "versionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "startedAt": "2023-11-07T05:31:56Z",
  "expiresAt": "2023-11-07T05:31:56Z",
  "region": "<string>",
  "params": {},
  "results": "<string>",
  "endedAt": "2023-11-07T05:31:56Z",
  "cause": {
    "message": "<string>"
  }
}

Authorizations

X-BB-API-Key · string · header · required

Your Browserbase API Key.

Path Parameters

id · string<uuid> · required

Response

200 - application/json

The request has succeeded.

id · string<uuid> · required

projectId · string<uuid> · required

functionId · string<uuid> · required

versionId · string<uuid> · required

sessionId · string<uuid> · required

status · enum<string> · required

Available options: PENDING, RUNNING, COMPLETED, FAILED

createdAt · string<date-time> · required

updatedAt · string<date-time> · required

startedAt · string<date-time> · required

expiresAt · string<date-time> · required

region · string

Minimum string length: 1

params · object

JSON object that can be stored in a JSONB column

results · string number boolean any[] object

Any JSON-serializable value that can be stored in a JSONB column

endedAt · string<date-time>

cause · object

Show child attributes