Link in bio API

Komi

Live private service

Retrieve creator profiles, social accounts, and rich links from public Komi pages.

Read the profile and modules used by Komi’s public frontend. Includes products, music destinations, podcasts, videos, and events without a Komi login.

Base URLhttp://localhost:3008

Local development example. Replace with your service origin.

Get a Komi profile

GET/v1/komi

Pass one public Komi profile URL. Tracking parameters and fragments are removed. Returned URLs are data; their destinations are never fetched.

Query parameters

Field	Type	Description
url	string	Required. An HTTPS <username>.komi.io profile URL. Custom domains and paths are unsupported.

Request cURL

export BASE_URL="http://localhost:3008"
export API_KEY="your-service-key"

curl --get "$BASE_URL/v1/komi" \
  -H "x-api-key: $API_KEY" \
  --data-urlencode "url=https://example.komi.io/"

Response fields

Field	Type	Description
id	string	Komi profile UUID, distinct from its numeric user ID.
username	string	Canonical Komi username.
avatar	string \| null	Account avatar URL, or null when unavailable.
bio	string \| null	Public profile bio, preserving empty strings; null when unavailable.
firstName	string \| null	Public first name, or null.
lastName	string \| null	Public last name, or null.
displayName	string \| null	Public display name, or null.
displayNameImage	string \| null	Public image used as the display name, or null.
website	string \| null	Profile website field. Null when Komi publishes no value.
instagram	string	Published instagram social link; omitted if absent.
tiktok	string	Published tiktok social link; omitted if absent.
youtube	string	Published youtube social link; omitted if absent.
twitter	string	Published twitter social link; omitted if absent.
facebook	string	Published facebook social link; omitted if absent.
snapchat	string	Published snapchat social link; omitted if absent.
spotify	string	Published spotify social link; omitted if absent.
apple_music	string	Published apple music social link; omitted if absent.
deezer	string	Published deezer social link; omitted if absent.
soundcloud	string	Published soundcloud social link; omitted if absent.
twitch	string	Published twitch social link; omitted if absent.
discord	string	Published discord social link; omitted if absent.
linkedin	string	Published linkedin social link; omitted if absent.
email	string	Published email social link; omitted if absent.
links	array	Ordered public module records. Groups flatten in source order; music and podcast destinations become individual records. Products preserve prices and currency. Video titles come from metadata when present. IDs are absent on some music destinations. Music uses the parent item subtype, such as NORMAL, while podcasts use PODCAST.
requestId	string	Identifier for correlating a request with operational logs.
accounting	object	Upstream requests, decoded JSON bytes read across both responses, and total duration. Discarded error bodies are excluded.
success	boolean	True when usable profile data is returned, including partial results.
status	string	success or partial. Failures return failed or challenged with a failure object.
sourceUrl	string	Final canonical profile URL after allowed redirects.
fetchedAt	string	UTC timestamp of retrieval.
coverage	object	Supported public API data only. Inspect warnings and optional moduleFailure when module retrieval is incomplete.

Nested fields and every response variant are in the OpenAPI specification.

Response 200 · synthetic example

{
  "success": true,
  "status": "success",
  "requestId": "00000000-0000-4000-8000-000000000001",
  "fetchedAt": "2026-09-10T00:00:00.000Z",
  "id": "00000000-0000-4000-8000-000000000002",
  "username": "example",
  "avatar": "https://example.test/avatar.png",
  "bio": "Synthetic creator",
  "firstName": "Example",
  "lastName": "Creator",
  "displayName": "Example Creator",
  "displayNameImage": null,
  "instagram": "https://instagram.com/example",
  "website": null,
  "links": [
    {
      "id": "link-1",
      "type": "LINK",
      "url": "https://example.test/",
      "title": "Website",
      "order": 0,
      "visible": true
    },
    {
      "id": "product-1",
      "type": "PRODUCT",
      "url": "https://example.test/shop",
      "title": "Studio T-shirt",
      "price": 44,
      "currency": "USD",
      "visible": false
    },
    {
      "type": "NORMAL",
      "url": "https://example.test/music",
      "isVisible": true
    }
  ],
  "sourceUrl": "https://example.komi.io/",
  "coverage": {
    "source": "public_api",
    "complete": true,
    "warnings": []
  },
  "accounting": {
    "upstreamRequests": 2,
    "responseBytes": 18000,
    "durationMs": 750
  }
}

Coverage & limits

One profile per request; four concurrent requests per worker. Additional requests receive 503 busy.
Two public JSON reads, with a 15-second total deadline and at most three upstream attempts. One retry per read for network errors or HTTP 5xx, within that shared budget.
At most 2 MiB of decoded JSON across both responses; 500 output links, ten nested levels, and 5,000 examined nodes.
Module fields vary by type. Additional public JSON attributes, nested metadata, nulls, and false visibility flags are preserved. A false visibility flag is not an access gate.
Access-gated modules and records containing nonempty secret codes, passwords, or secret links are omitted with a warning. Protected content is never unlocked.
If modules fail, usable profile metadata is returned with status partial, empty links, and coverage.moduleFailure. An overall deadline returns timeout.
Fresh retrieval only. Custom domains, localization selection, caching, private analytics, customer billing, and destination scraping are unsupported.
Coverage is based on Komi’s public profile and module endpoints. It does not guarantee every localized page, media feed, or account feature.

Errors & partial results

HTTP	Code / status	Meaning
400	invalid_request	Invalid URL, missing URL, duplicates, or unsupported parameters.
401	unauthorized	Missing or invalid service API key.
403	restricted_page	The profile requires access or consent.
404	not_found	The profile is missing or inactive.
429	upstream_rate_limited	Komi rate limited the request; no automatic retry.
502	upstream_challenged	The upstream rejected or challenged the request.
502	unsupported_page	Data is missing, malformed, or belongs to another profile.
502	response_too_large / unsafe_redirect / request_limit / upstream_error	Retrieval could not safely complete.
503	busy	All worker slots are in use.
504	timeout	The request exceeded its deadline.
200	partial	Profile metadata is usable, but coverage warnings identify missing modules, fields, gates, or limits.