Skip to content

API errors & troubleshooting

Local API requires Pro membership and a running client. Use the port and api-key from the API screen.

Live spec: Apifox · KDocs

Response shape

Success: { "success": true, "data": { ... } }
Failure: { "success": false, "error": "..." }

Many failures still return HTTP 200always check success.

HTTP status codes

CodeMeaningExamples
200HandledOK or success: false in body
400Bad requestMissing id, Invalid id format
401UnauthorizedBad/missing api-key; cloud sync not signed in
403ForbiddenCloud sync without Pro
404Not foundUnknown profile/group id
429Rate limitedWrite queue full
500Server errorUsually error.message from client

Auth & permissions

ErrorHTTPFix
Unauthorized: Invalid API key401Copy fresh key from API
Connection refusedStart client; verify port
请先登录后再进行云同步401Sign in to the client
仅限会员使用云同步功能403Subscribe to Pro

Validation (400)

ErrorMeaning
Missing required parameter: idBody missing id
Missing required parameter: id, name, or remark.launchBrowser needs one identifier
Missing required parameter: cookiesCookie update
Missing or invalid parameter: accounts (must be an array)Platform accounts API
Invalid id formatid not a valid integer

Not found (404)

PatternMeaning
browser(id: N) not foundProfile missing
Browser with id N not foundSame (variant wording)
group(id: N) not foundGroup missing
Browser data directory not found for id: NData dir deleted
Browser list is empty or not found.No profiles

Launch / stop

ErrorAction
browser(id: N) is runningUse returned debuggingPort or stop first
No browser found with …Fix id/name/remark via getBrowserList
Multiple browsers found with …Use unique id
No browser data found for worker ID: NRestore backup or recreate
Failed to parse proxy from API responseFix proxy extract URL format
Failed to fetch proxy from API: …Network/auth on proxy API
Browser process closed before DevTools port was detected.Kernel/proxy/AV issue
Failed to detect DevTools port for worker N…Close conflicting Chromium

Rate limiting

ErrorHTTP
Too many concurrent write requests, please retry later429

INFO

Exact strings follow the installed client—see Apifox after upgrades.

Checklist

  1. Pro active, client running
  2. api-key header
  3. Correct port
  4. Parse JSON → success
  5. CDP: Playwright guide