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

Request

  • Base URL: https://agent.tinyfish.ai
  • URL: https://agent.tinyfish.ai/v1/profiles/{profileId}/save
  • Auth: API key in header X-API-Key

Path parameters

profileIdstring required

Browser Context Profile ID

Example:prof_abc123def4567890

Request body

session_idstring required
signed_in_sitesstring[]

Sites the user says they signed into during this setup, as hosts or URLs. Each is recorded as signed in only if this save wrote cookies for it; for sites TinyFish can check, its sign-in cookie must be saved too. Ignored when sign-in tracking is not enabled for the account.

Example request

{
  "session_id": "br-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "signed_in_sites": [
    "facebook.com"
  ]
}

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
signed_in_sitesstring[]

Sites this save recorded as signed in, from sign-in cookies set during setup. Omitted when sign-in tracking is not enabled for the account.

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",
  "signed_in_sites": [
    "github.com"
  ],
  "sign_in": {
    "site": "github.com",
    "status": "recorded"
  },
  "user_confirmed_sites": {
    "recorded": [
      "facebook.com"
    ],
    "rejected": [
      {
        "site": "notion.so",
        "reason": "not_saved"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.