Skip to main content
POST
/
v1
/
profiles
/
{profileId}
/
setup-session
/
cancel
Cancel a profile setup session
curl --request POST \
  --url https://agent.tinyfish.ai/v1/profiles/{profileId}/setup-session/cancel \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "session_id": "br-a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
'
{
  "cancelled": true
}

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

Cancel a profile setup session succeeded.

​
cancelled
boolean
required
Example:

true