v1

latestOpenAPI 3.0.02026-07-26300209.6 KB

Browser Context Profiles

Save a profile setup session

Captures cookies, local storage, and session storage from a running setup session into the Browser Context Profile. Requires the session_id returned by setup-session.

post/v1/profiles/{profileId}/save

Path parameters

profileIdstring required

Browser Context Profile ID

Example:prof_abc123def4567890

Browser Context Profile ID

Request body

session_idstring required

Example request

{
  "session_id": "br-a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Response

Save a profile setup session succeeded.

domains_updatedstring[] required

domains_failedstring[] required

cookie_countinteger required

pages_capturedinteger

target_reads_skippedinteger

cleanup_failedboolean

cleanup_kindstring

Example response

{
  "domains_updated": [
    "example.com"
  ],
  "domains_failed": [],
  "cookie_count": 12,
  "domains_skipped": {
    "cookies_skipped": [],
    "local_storage_skipped": [],
    "session_storage_skipped": [],
    "blob_too_large": []
  },
  "pages_captured": 1,
  "cleanup_kind": "post_save"
}