> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.flashid.app/api-reference/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.flashid.app/_mcp/server. # Overview # FlashID Local API Programmatic access to the FlashID desktop client over a local HTTP service. | | | | ---------------------- | ------------------------------------------------------------------- | | **Base URL** | `http://127.0.0.1:58931` (the `baseUrl` variable) | | **Auth** | `X-API-Key` header on every request except `GET /api/system/health` | | **Binding** | `127.0.0.1` only — not exposed to the network | | **Enabled by default** | Off — enable it on the client Settings page | Set your key in the `apiKey` collection variable. Each request includes a saved **Example** response. ## Profile tags Create and manage workspace tags through the Tags endpoints. Profile list and detail responses include their associated `tags`. When creating or updating a profile, pass `tag_uuids` to set its complete tag list, or use the attach and detach endpoints to change one association at a time. ## Response envelope Success: `{ "success": true, "code": 0, "data": {...} }` Error: `{ "success": false, "code": , "message": "..." }` ## Error codes **Every response is HTTP 200** — the body `code` is the sole signal (`success:false` + non-zero `code` on error). | `code` | Name | | ------ | ----------------------------- | | `0` | SUCCESS | | `1001` | UNAUTHORIZED | | `1002` | INVALID\_API\_KEY | | `1003` | RATE\_LIMITED | | `1004` | FORBIDDEN | | `1005` | NOT\_IN\_WORKSPACE | | `2001` | BAD\_REQUEST | | `2002` | VALIDATION\_FAILED | | `2003` | MISSING\_PARAM | | `3001` | BROWSER\_OPEN\_FAILED | | `3002` | BROWSER\_CLOSE\_FAILED | | `3003` | BROWSER\_NOT\_FOUND | | `3004` | BROWSER\_IN\_USE | | `3005` | DISK\_INSUFFICIENT | | `3006` | WRITE\_PERMISSION\_DENIED | | `3007` | KERNEL\_ERROR | | `3008` | KERNEL\_DOWNLOADING | | `3009` | BROWSER\_LAUNCH\_FAILED | | `3010` | CONFIG\_FETCH\_FAILED | | `3011` | FILE\_PREPARE\_FAILED | | `3012` | BROWSER\_OPEN\_TIMEOUT | | `4001` | PROXY\_CHECK\_FAILED | | `4002` | PROXY\_INVALID | | `5001` | PROFILE\_NOT\_FOUND | | `5002` | PROFILE\_FETCH\_FAILED | | `5003` | QUOTA\_EXCEEDED | | `5004` | PROFILE\_CREATE\_FAILED | | `5005` | SUBSCRIPTION\_EXPIRED | | `6001` | FOLDER\_NOT\_FOUND | | `6002` | WORKSPACE\_NOT\_FOUND | | `7001` | TAG\_NAME\_EXISTS | | `7002` | TAG\_LIMIT\_EXCEEDED | | `7003` | PROFILE\_TAG\_LIMIT\_EXCEEDED | | `7004` | TAG\_NOT\_FOUND | | `9001` | INTERNAL\_ERROR | | `9002` | SERVICE\_UNAVAILABLE | ## Rate limiting ## Docs - [Overview](https://docs.flashid.app/api-reference/system.md) - [Overview](https://docs.flashid.app/api-reference/profiles.md) - [Tags](https://docs.flashid.app/api-reference/tags.md) - [Overview](https://docs.flashid.app/api-reference/browsers.md) - [Overview](https://docs.flashid.app/api-reference/proxies.md) - [Overview](https://docs.flashid.app/api-reference/folders.md) - [Overview](https://docs.flashid.app/api-reference/trash.md) ## API Docs - FlashID Local API > System [Health check](https://docs.flashid.app/api-reference/system/health-check.md) - FlashID Local API > System [Service info](https://docs.flashid.app/api-reference/system/get-system-info.md) - FlashID Local API > System [Validate API Key](https://docs.flashid.app/api-reference/system/validate-api-key.md) - FlashID Local API > Profiles [List profiles](https://docs.flashid.app/api-reference/profiles/list-profiles.md) - FlashID Local API > Profiles [Create profile](https://docs.flashid.app/api-reference/profiles/create-profile.md) - FlashID Local API > Profiles [Get profile detail](https://docs.flashid.app/api-reference/profiles/get-profile-detail.md) - FlashID Local API > Profiles [Update profile](https://docs.flashid.app/api-reference/profiles/update-profile.md) - FlashID Local API > Profiles [Delete profile](https://docs.flashid.app/api-reference/profiles/delete-profile.md) - FlashID Local API > Profiles [Quick update profile](https://docs.flashid.app/api-reference/profiles/quick-update-profile.md) - FlashID Local API > Profiles [Toggle star](https://docs.flashid.app/api-reference/profiles/toggle-star.md) - FlashID Local API > Profiles [Get fingerprint options](https://docs.flashid.app/api-reference/profiles/get-fingerprint-options.md) - FlashID Local API > Profiles [Generate random fingerprint](https://docs.flashid.app/api-reference/profiles/generate-random-fingerprint.md) - FlashID Local API > Tags [Add tag to profile](https://docs.flashid.app/api-reference/tags/attach-profile-tag.md) - FlashID Local API > Tags [Remove tag from profile](https://docs.flashid.app/api-reference/tags/detach-profile-tag.md) - FlashID Local API > Tags [List tags](https://docs.flashid.app/api-reference/tags/list-tags.md) - FlashID Local API > Tags [Create tag](https://docs.flashid.app/api-reference/tags/create-tag.md) - FlashID Local API > Tags [Update tag](https://docs.flashid.app/api-reference/tags/update-tag.md) - FlashID Local API > Tags [Delete tag](https://docs.flashid.app/api-reference/tags/delete-tag.md) - FlashID Local API > Browsers [Open browser](https://docs.flashid.app/api-reference/browsers/open-browser.md) - FlashID Local API > Browsers [Close browsers](https://docs.flashid.app/api-reference/browsers/close-browsers.md) - FlashID Local API > Browsers [List running browsers](https://docs.flashid.app/api-reference/browsers/list-running-browsers.md) - FlashID Local API > Proxies [List proxies](https://docs.flashid.app/api-reference/proxies/list-proxies.md) - FlashID Local API > Proxies [Add proxies](https://docs.flashid.app/api-reference/proxies/add-proxies.md) - FlashID Local API > Proxies [Proxy tab counts](https://docs.flashid.app/api-reference/proxies/get-proxy-tab-counts.md) - FlashID Local API > Proxies [Region tree](https://docs.flashid.app/api-reference/proxies/get-region-tree.md) - FlashID Local API > Proxies [Update proxy](https://docs.flashid.app/api-reference/proxies/update-proxy.md) - FlashID Local API > Proxies [Delete proxy](https://docs.flashid.app/api-reference/proxies/delete-proxy.md) - FlashID Local API > Proxies [Check a proxy](https://docs.flashid.app/api-reference/proxies/check-proxy.md) - FlashID Local API > Folders [List folders](https://docs.flashid.app/api-reference/folders/list-folders.md) - FlashID Local API > Folders [Create folder](https://docs.flashid.app/api-reference/folders/create-folder.md) - FlashID Local API > Folders [Update folder](https://docs.flashid.app/api-reference/folders/update-folder.md) - FlashID Local API > Folders [Delete folder](https://docs.flashid.app/api-reference/folders/delete-folder.md) - FlashID Local API > Folders [Reorder folders](https://docs.flashid.app/api-reference/folders/reorder-folders.md) - FlashID Local API > Trash [List trashed profiles](https://docs.flashid.app/api-reference/trash/list-trash.md) - FlashID Local API > Trash [Permanently delete profiles](https://docs.flashid.app/api-reference/trash/permanently-delete-profiles.md) - FlashID Local API > Trash [Restore profiles](https://docs.flashid.app/api-reference/trash/restore-profiles.md) - FlashID Local API > Trash [Restore all](https://docs.flashid.app/api-reference/trash/restore-all-profiles.md) - FlashID Local API > Trash [Empty trash](https://docs.flashid.app/api-reference/trash/empty-trash.md) ## OpenAPI Specification The raw OpenAPI 3.1 specification for this API is available at: - [OpenAPI JSON](https://docs.flashid.app/api-reference/openapi.json) - [OpenAPI YAML](https://docs.flashid.app/api-reference/openapi.yaml)