Onboarding

Advance onboarding without allowing progress to move backward

patch/onboarding

Request

  • Base URL: https://api.flashdata.dev/v2
  • URL: https://api.flashdata.dev/v2/onboarding
  • Auth: API key in cookie __Host-fd_session and API key in header X-CSRF-Token

Request body

versioninteger required
action'select_use_case' | 'confirm_api_key_saved' | 'skip_api_key' | 'confirm_first_request' | 'skip_first_request' required
useCase'google_search' | 'youtube_data' | 'download'

Response

Updated onboarding state

currentStep'welcome' | 'api_key' | 'first_request' | 'completed' required
useCase'google_search' | 'youtube_data' | 'download' | 'null' nullable
apiKeyStepStatus'pending' | 'created' | 'skipped' required
firstRequestStatus'pending' | 'succeeded' | 'skipped' required
firstApiKeyIdstring nullable
firstRequestIdstring nullable
completedAtstring date-time nullable
versioninteger required
updatedAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.