Skip to main content
POST
/
v1
/
profiles
/
{profileId}
/
save
Save a profile setup session
curl --request POST \
  --url https://agent.tinyfish.ai/v1/profiles/{profileId}/save \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "session_id": "br-a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
'
{
  "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,
  "target_reads_skipped": 0,
  "cleanup_failed": false,
  "cleanup_kind": "post_save"
}

Authorizations

​
X-API-Key
string
header
required

API key for authentication. Get your key from the API Keys page.

Path Parameters

​
profileId
string
required

Browser Context Profile ID

Minimum string length: 1
Example:

"prof_abc123def4567890"

Body

application/json
​
session_id
string
required
Minimum string length: 1
Example:

"br-a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Response

Save a profile setup session succeeded.

​
domains_updated
string[]
required
Example:
["example.com"]
​
domains_failed
string[]
required
Example:
[]
​
cookie_count
integer
required
Required range: x >= 0
Example:

12

​
domains_skipped
object
required
​
pages_captured
integer
Required range: x >= 0
Example:

1

​
target_reads_skipped
integer
Required range: x >= 0
Example:

0

​
cleanup_failed
boolean
Example:

false

​
cleanup_kind
string
Example:

"post_save"