Skip to main content
POST
/
browser
/
sessions
/
{id}
/
reload
Reload
curl --request POST \
  --url https://api.example.com/browser/sessions/{id}/reload \
  --header 'Content-Type: application/json' \
  --data '
{
  "ignoreCache": true,
  "waitUntil": "<string>",
  "timeout": 123
}
'
{
  "url": "<string>",
  "pageId": "<string>"
}

Overview

The /browser/sessions/{id}/reload endpoint reloads the currently active tab. By default the reload reuses the HTTP cache; pass ignoreCache: true to force a full re-fetch of all resources. The call blocks until the configured wait condition is met or the timeout elapses.

Path Parameters

id
string
required
Browser session ID (UUID). Create via POST /browser/sessions.

Body

All body fields are optional — the request body may be omitted entirely.
ignoreCache
boolean
default:"false"
When true, bypasses the HTTP cache (equivalent to Ctrl+Shift+R). Re-fetches all resources from origin.
waitUntil
string
default:"load"
When to consider the reload finished. One of load, domcontentloaded, networkidle.
timeout
integer
default:"30000"
Maximum time (ms) to wait for the reload to complete. Range 0120000.

Example Request

curl -X POST "https://api.scrapengine.io/api/v1/browser/sessions/0f2b1f6a-88ac-4d25-bc58-67a6f4b4a001/reload" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Response

Success Response (200)

url
string
Effective URL of the active tab after reload.
pageId
string
CDP target identifier of the tab the reload applied to.
Example Response:
{
  "url": "https://example.com/",
  "pageId": "EA5E9AA71C7A91C467F8CDBB266EE5E0"
}

Error Responses

StatusDescription
401Unauthorized — invalid or missing API key.
404Session not found or not owned by the caller.
408Reload did not complete before timeout elapsed.
503The browser session is temporarily unreachable.

Notes

  • ignoreCache: true is equivalent to Ctrl+Shift+R — re-fetches all resources bypassing the HTTP cache.
  • The URL of the active tab is preserved across reloads; only the document and its subresources are refetched.