List Interact Sessions

Retrieve your standalone Interact sessions, optionally filtered by status.

GET /interact

List interact sessions

cURL

curl --request GET \
  --url https://api.firecrawl.dev/v2/interact \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.firecrawl.dev/v2/interact"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.firecrawl.dev/v2/interact', 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.firecrawl.dev/v2/interact",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.firecrawl.dev/v2/interact"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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.firecrawl.dev/v2/interact")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.firecrawl.dev/v2/interact")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

200

{
  "success": true,
  "sessions": [
    {
      "id": "<string>",
      "cdpUrl": "<string>",
      "liveViewUrl": "<string>",
      "interactiveLiveViewUrl": "<string>",
      "streamWebView": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "lastActivity": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "error": "Payment required to access this resource."
}

Headers

Header	Value
Authorization	Bearer <API_KEY>

Query Parameters

Parameter	Type	Required	Description
status	string	No	Filter by session status: "active" or "destroyed"

Response

Field	Type	Description
success	boolean	Whether the request succeeded
sessions	array	List of session objects

Session Object

Field	Type	Description
id	string	Unique session identifier
status	string	Current session status ("active" or "destroyed")
cdpUrl	string	WebSocket URL for CDP connections
liveViewUrl	string	URL to watch the session in real time
interactiveLiveViewUrl	string	URL to interact with the session in real time (click, type, scroll)
createdAt	string	ISO 8601 timestamp of session creation
lastActivity	string	ISO 8601 timestamp of last activity

Example Request

curl -X GET "https://api.firecrawl.dev/v2/interact?status=active" \
  -H "Authorization: Bearer $FIRECRAWL_API_KEY"

Example Response

{
  "success": true,
  "sessions": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "status": "active",
      "cdpUrl": "wss://cdp-proxy.firecrawl.dev/cdp/550e8400-e29b-41d4-a716-446655440000",
      "liveViewUrl": "https://liveview.firecrawl.dev/550e8400-e29b-41d4-a716-446655440000",
      "interactiveLiveViewUrl": "https://liveview.firecrawl.dev/550e8400-e29b-41d4-a716-446655440000?interactive=true",
      "createdAt": "2025-06-01T12:00:00Z",
      "lastActivity": "2025-06-01T12:05:30Z"
    }
  ]
}

Are you an AI agent that needs a Firecrawl API key? See firecrawl.dev/agent-onboarding/SKILL.md for automated onboarding instructions.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

status · enum<string>

Filter sessions by status

Available options: active, destroyed

Response

200

application/json

List of interact sessions

success · boolean

sessions · object[]

Show child attributes