/
KA
kameleo-io
/
kameleo-local-api
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 16m ago · Updated 3w ago
View markdown
kameleo-io
kameleo-local-api
delete
Permanently delete a profile from your workspace.
latest
OpenAPI 3.0.4
raw.githubusercontent.com
2026-08-03
32
67
145.4 KB
dc959e78ce25
Cookie
3
Fingerprint
1
Folder
9
General
3
Kernel
3
Profile
13
get
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
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
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
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
Permanently delete a profile from your workspace.
get
Check the current status of a profile, including its lifecycle and persistence states.
post
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
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
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
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
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
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
Installs the kernel that best suits the specified profile's fingerprint, downloading it if it's not already available locally.
Profile
Permanently delete a profile from your workspace.
delete
/profiles/{profileId}
Path parameters
profileId
string
uuid
required
The unique identifier of the profile
Response
OK.