Create Interact Session - Firecrawl Docs

curl --request POST \ --url https://api.firecrawl.dev/v2/interact \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "ttl": 300, "activityTtl": 10, "streamWebView": true, "profile": { "name": "<string>", "saveChanges": true } }'

Headers#

Header	Value
`Authorization`	`Bearer <API_KEY>`
`Content-Type`	`application/json`

Request Body#

Parameter	Type	Required	Default	Description
`ttl`	number	No	600	Total session lifetime in seconds (30-3600)
`activityTtl`	number	No	300	Seconds of inactivity before session is destroyed (10-3600)
`profile`	object	No	—	Enable persistent storage across sessions. See below.
`profile.name`	string	Yes*	—	Name for the profile (1-128 chars). Sessions with the same name share storage.
`profile.saveChanges`	boolean	No	`true`	When `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#

Field	Type	Description
`success`	boolean	Whether the session was created
`id`	string	Unique session identifier
`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)
`expiresAt`	string	When 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.

Headers#

Request Body#

Response#

Example Request#

Example Response#

Authorization

Body

Responses