KOL Database

Run Kol Deep Overview

Run the premium deep analysis and charge the workspace pool (falling back to personal credits via credits.charge). Cost is governed by settings.deep_analysis_cost_credits (default 2).

Charge-then-generate semantics:

  • 402 if the combined workspace + personal balance can't cover it.
  • On a successful charge we always attempt the LLM call. If the gateway 503s after the debit, we refund the workspace half immediately (personal-side refunds aren't possible without Supabase write paths, so we surface a clear 503 detail and the operator can mail-in support — same UX as the scrape route).
post/api/kols/{username}/deep-overview

Request

  • Base URL: https://api.kolens.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.kolens.ai/api/kols/{username}/deep-overview
  • Auth: HTTP bearer

Path parameters

usernamestring required

Query parameters

localestring

Output locale — en / zh-CN / ja

Headers

x-kolens-user-idstring nullable
x-kolens-workspace-idstring nullable

Response

Successful Response

overall_summarystring required
content_themesstring[] required
audience_signalstring required
partnership_signalsstring[] required
red_flagsstring[] required
fit_forstring[] required
recommendation_scoreinteger nullable
content_fit_scoreinteger nullable
audience_fit_scoreinteger nullable
risk_scoreinteger nullable
score_rationalestring nullable
brand_profile_statusstring
workspace_slugstring nullable
content_qualitystring
partnership_historystring
outreach_strategystring[]
negotiation_notesstring
competitive_contextstring
generated_atstring required
videos_analyzedinteger required
cost_creditsinteger required
model_usedstring nullable
cachedboolean required

Changes

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