Sign in
claude

Get onboarding status

Returns the current state of the onboarding process

get/v1/claude/onboarding/status

Query parameters

include_outputboolean

Include full PTY output buffer

Response

OK

error_messagestring

Error message if state is 'error'

messagestring

Human-readable message about the current state

oauth_urlstring

OAuth URL for authentication (only present in auth_url and auth_waiting states)

outputstring

Full PTY output buffer for debugging (only included if requested)

state'idle' | 'theme_select' | 'auth_method' | 'auth_url' | 'auth_waiting' | 'auth_confirm' | 'security_notes' | 'terminal_setup' | 'complete' | 'error'

Current state in the onboarding flow

Example response

{
  "error_message": "Timeout in state auth_waiting after 3m0s",
  "message": "Please visit the OAuth URL and paste the code",
  "oauth_url": "https://claude.ai/oauth/authorize?...",
  "state": "auth_waiting"
}

Changes

Changed in 2 of the 50 revisions of this API.11