Skip to content
scrapeatlas.Dashboard

Link in bio

Komi API

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

1 endpointx-api-key

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

API availability: Available

Base URL · local workerhttp://localhost:3008Public API: https://api.scrapeatlas.com.
Authenticationx-api-keyCustomer key from your account. See Authentication.

Endpoints

GET/v1/komi

Get a Komi profile

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

Reference

Quick start

Create an API key on your account page, then call the public API. Values below are placeholders.

Terminal
curl "https://api.scrapeatlas.com/v1/komi?url=https%3A%2F%2Fexample.komi.io%2F" \
  -H "x-api-key: YOUR_API_KEY"

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 carrying secret codes, passwords or secret links are left out with a warning.
  • If modules fail, usable profile metadata is returned with status partial, empty links, and coverage.moduleFailure. An overall deadline returns timeout.
  • Fresh retrieval on every request.
  • Coverage is based on Komi’s public profile and module endpoints.
Error codes
11
HTTPfailure.codeMeaning
400invalid_requestInvalid URL, missing URL, duplicates, or unsupported parameters.
401unauthorizedMissing or invalid service API key.
403restricted_pageThe profile requires access or consent.
404not_foundThe profile is missing or inactive.
429upstream_rate_limitedKomi rate limited the request; no automatic retry.
502upstream_challengedThe upstream rejected or challenged the request.
502unsupported_pageData is missing, malformed, or belongs to another profile.
502response_too_large unsafe_redirect request_limit upstream_errorRetrieval could not safely complete.
503busyAll worker slots are in use.
504timeoutThe request exceeded its deadline.
200partialProfile metadata is usable, but coverage warnings identify missing modules, fields, gates, or limits.