Skip to content
Firecrawl Docsv2
Firecrawl Docs
Interact Endpoints

Create Interact Session

POST/interact

Start a standalone Interact browser session you drive with code (no prior scrape required).

Headers

HeaderValue
AuthorizationBearer <API_KEY>
Content-Typeapplication/json

Request Body

ParameterTypeRequiredDefaultDescription
ttlnumberNo600Total session lifetime in seconds (30-3600)
activityTtlnumberNo300Seconds of inactivity before session is destroyed (10-3600)
profileobjectNoEnable persistent storage across sessions. See below.
profile.namestringYes*Name for the profile (1-128 chars). Sessions with the same name share storage.
profile.saveChangesbooleanNotrueWhen true, browser state is saved back to the profile on close. Set to false to load existing data without writing. Only one saver is allowed at a time.

Response

FieldTypeDescription
successbooleanWhether the session was created
idstringUnique session identifier
cdpUrlstringWebSocket URL for CDP connections
liveViewUrlstringURL to watch the session in real time
interactiveLiveViewUrlstringURL to interact with the session in real time (click, type, scroll)
expiresAtstringWhen the session will expire based on TTL

Example Request

curl -X POST "https://api.firecrawl.dev/v2/interact" \
  -H "Authorization: Bearer $FIRECRAWL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "ttl": 120
  }'

Example Response

{
  "success": true,
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "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"
}

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

Was this page helpful?Suggest editsRaise issue