Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. By signing up you are subscribing to the APIs.io and API Evangelist
newsletters — you can unsubscribe from any issue. See our
Privacy Policy and Terms.
openapi: 3.2.0
info:
title: KOLens System API
description: KOLens — TikTok KOL Intelligence API. Search keywords, extract KOL profiles, collect contact info, export reports.
version: 1.0.0
tags:
- name: System
paths:
/healthz:
get:
tags:
- System
summary: Healthz
description: 'Lightweight liveness endpoint for platform health checks (Railway/Render).
No DB, no Settings, no async dependency — answers the moment the
HTTP server starts accepting connections. This is what Railway''s
healthcheckPath in railway.toml points at; if you''re tempted to
add anything that could block, stop and add it to /readyz instead.
Also reports the image''s git SHA, which is what makes "did the
merge actually go live?" answerable in one unauthenticated request
instead of inferred from a green deploy job.'
operationId: healthz_healthz_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/HealthzResponse'
/readyz:
get:
tags:
- System
summary: Readyz
description: 'Readiness probe — distinct from liveness.
Returns 200 only AFTER the lifespan''s background init finished
(tables created, migrations run, schedulers started). 503 in the
meantime. Useful for blue/green deploy systems that wait for full
readiness before sending traffic — Railway''s liveness check still
points at /healthz so a slow background init doesn''t kill the
container, but a load balancer in front can use /readyz to know
when this instance is fully warmed.'
operationId: readyz_readyz_get
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
/health:
get:
tags:
- System
summary: Health Check
description: 'Returns service status. Used by Railway for health monitoring
and by the Cowork Plugin to verify the API is reachable.'
operationId: health_check_health_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/HealthResponse'
components:
schemas:
HealthResponse:
properties:
status:
type: string
title: Status
version:
type: string
title: Version
app_name:
type: string
title: App Name
type: object
required:
- status
- version
- app_name
title: HealthResponse
HealthzResponse:
properties:
ok:
type: boolean
title: Ok
revision:
anyOf:
- type: string
- type: 'null'
title: Revision
type: object
required:
- ok
title: HealthzResponse
description: 'Liveness, plus the one fact you cannot get any other way.
``revision`` is the git SHA baked into the image at build time. It
exists because "is the merge live?" had no answer from outside: the
deploy job reporting success proves a build ran and a health check
passed, not that the machine serving traffic is running the commit
you merged. #785 shipped and the only way to check was to infer it.
The deploy workflow''s own comments record a release that looked
merged and was live nowhere for 20 minutes.
``None`` when the image was built without the build-arg — local
runs, and any older image. Absence means unknown, never "stale".'
securitySchemes:
HTTPBearer:
type: http
scheme: bearer