/
KA
kameleo-io
Search skmtc…
⌘K
Docs
Sign in
Docs
History
Schema
Generate
Filter operations
Cookie
3
Fingerprint
1
Folder
9
General
4
Kernel
3
Profile
15
get
/profiles
Retrieve a list of all profiles loaded in your workspace. Use this endpoint to view a preview of each profile so you can quickly assess available profiles.
post
/profiles/search
Retrieve a page of profile previews with server-side filtering and sorting to optimize querying profiles. Only the properties of ProfilePreview can be filtered and sorted.
post
/profiles/new
Create a new profile based on a selected fingerprint. Supply the required configuration in the request body, then receive the newly created profile’s full details.
get
/profiles/{profileId}
Gets the profile with the specified GUID from the current workspace. On startup, Kameleo will automatically scan and load profiles stored in your workspace folder on startup.
put
/profiles/{profileId}
Update an existing profile’s settings by providing the new configuration options in the request body. Use this to modify aspects like spoofing options or proxy settings, then receive the updated profile details.
delete
/profiles/{profileId}
Permanently delete a profile from your workspace.
post
/profiles/{profileId}/test-proxy
Tests the proxy connection configured on the given profile and returns every individual test step together with an overall summary. The summary is 'success' when every step passes, 'partial_success' when the website could be reached through at least one of IPv4, IPv6 or DNS name and the IP location lookup also succeeded, otherwise 'failure'.
get
/profiles/{profileId}/status
Check the current status of a profile, including its lifecycle and persistence states.
post
/profiles/{profileId}/start
Starts the selected profile by transitioning its status to 'starting', launching the kernel (Chroma or Junglefox) associated with the profile, and then changing its status to 'running'. If there is an error during start-up, it will be 'terminated'. Note that the required kernel might not be available locally, so it may be downloaded during the profile start. Optional command line arguments or settings can be passed to the browser engines.
post
/profiles/{profileId}/stop
Stop a running profile by gracefully shutting down its browser engine and releasing allocated resources. Use this endpoint to transition the profile from 'running' to 'terminated' state.
post
/profiles/{profileId}/export
Export a profile to a .kameleo file by providing the target file path in the request body. Use this to back up all profile attributes — including settings, browsing data, cookies, history, bookmarks, and extensions — for later restoration or migration.
post
/profiles/{profileId}/duplicate
Duplicate an existing profile by creating an exact copy with a new unique identifier. Use this endpoint to clone a profile while preserving all its configuration details and data.
post
/profiles/import
Imports a profile from a .kameleo file, effectively recreating the profile with all its attributes, including settings, browsing data, cookies, history, bookmarks, and any installed extensions/addons. If the profile is already loaded, the import process will fail.
post
/profiles/{profileId}/upgrade
Upgrades the profile's fingerprint to the most recent browser version available from the server. This also updates the profile's corresponding kernel if there's a better match available for the new fingerprint. The new fingerprint is tailored to the profile's current device, browser and operating system. Note that upgrading a profile's kernel will alter its browser fingerprint.
post
/profiles/{profileId}/kernel-install
Installs the kernel that best suits the specified profile's fingerprint, downloading it if it's not already available locally.
Profile
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Changes to Installs the kernel that best suits the specified profile's fingerprint, downloading it if it's not already available locally.
post
/profiles/{profileId}/kernel-install
Aug 3, 2026
dc959e78ce25
Revision changes
info
endpoint added