LinkDigest Search API
The Search API from LinkDigest — 1 operation(s) for search.
The Search API from LinkDigest — 1 operation(s) for search.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/linkdigest-dev:linkdigest-dev-search-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a 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.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: LinkDigest Search API
version: 1.0.0
description: '把抖音、小红书、红果短剧、TikTok、YouTube、X、Instagram 的链接变成 AI 能读的文本:逐字稿、画面文字、逐图描述、要点,可选爆款拆解和翻译。Turns social links into LLM-ready text — transcript, on-screen text, images, key points, and an optional viral breakdown. 10 free credits when you sign up; a post is 1 credit, video 1 per started minute, or 1 per started 2 minutes read transcript-first (depth=transcript); cached links are free. Key: https://linkdigest.dev/signin?ref=openapi&next=/app/keys'
servers:
- url: https://linkdigest.dev
security:
- bearer: []
tags:
- name: Search
paths:
/api/v1/search:
post:
operationId: search_links
summary: Find posts on a topic (Xiaohongshu, Douyin, YouTube, X, the web) — free
description: 'A search API built for agents (Linkup; Google or Brave optional) scoped to the platform, filtered to links digest_url can read. A search that finds posts costs 4 credits on douyin and xiaohongshu and 1 elsewhere; nothing found is free; 402 when the balance is short. Searching is metered by credits, not by an hourly count. digest: true also starts a batch over the results with synthesis (a result that will not read is skipped free and replaced by the next one found; the batch''s ranked lists the posts hottest first; draft: true also writes one post from them, +1 credit), labelled with the query, billed as a batch is. xiaohongshu returns the notes the web has indexed, read from their public pages with no login or session; the extension covers the user''s own feed. douyin returns the video pages the web has indexed (since 2026-10-21), each read through Douyin''s own embed player like a pasted link.'
requestBody:
required: true
content:
application/json:
schema:
type: object
description: What to search for.
properties:
query:
type: string
description: The topic, in any language.
maxLength: 200
platform:
type: string
description: 'Where to look: xiaohongshu, douyin, youtube, x, web.'
enum:
- xiaohongshu
- douyin
- youtube
- x
- web
limit:
type: integer
description: How many links, 1 to 10 (default 5).
minimum: 1
maximum: 10
digest:
type: boolean
description: Also read the results as one batch with synthesis (批量综合) and return its batch_id.
insight:
type: boolean
description: 'With digest: draw every post''s consumer insight, +1 credit a link.'
breakdown:
type: boolean
description: 'With digest: take every post apart, +1 credit a link.'
required:
- query
- platform
responses:
'200':
description: The links.
content:
application/json:
schema:
$ref: '#/components/schemas/Search'
'202':
description: The links, and the batch started over them (batch_id, batch).
content:
application/json:
schema:
$ref: '#/components/schemas/Search'
'400':
description: Malformed, or a session-only platform (error_code session_only, extension_url).
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Missing or revoked API key.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'429':
description: Too many searches; honour Retry-After.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'503':
description: Search is not configured on this server (error_code search_unavailable).
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- Search
components:
schemas:
Synthesis:
type:
- object
- 'null'
description: 批量综合 — one comparison over every link the batch read. Present only on a batch that asked for synthesis=true (null while it runs, or when it failed — synthesis_error says why and nothing was charged). 1 credit per started 10 notes, once per batch.
properties:
language:
type: string
description: The language the synthesis is written in, e.g. zh-CN or en.
notes:
type: integer
description: How many notes were compared.
summary:
type: string
description: The comparison in a paragraph.
themes:
type: array
items:
type: object
description: A theme the notes share.
properties:
text:
type: string
description: The point, in the synthesis's language.
count:
type: integer
description: How many of the notes it was seen in.
examples:
type: array
items:
type: object
description: One example and the note it came from, checked by code.
properties:
note:
type: integer
description: 1-based index into the batch's read links, in order (the items with status done or cached).
quote:
type: string
description: Verbatim from that note.
verified:
type: boolean
description: True when the engine found the quote word for word in that note.
description: Examples from the notes.
description: Shared themes.
hooks:
type: array
items:
type: object
description: An opening the notes use.
properties:
text:
type: string
description: The point, in the synthesis's language.
count:
type: integer
description: How many of the notes it was seen in.
examples:
type: array
items:
type: object
description: One example and the note it came from, checked by code.
properties:
note:
type: integer
description: 1-based index into the batch's read links, in order (the items with status done or cached).
quote:
type: string
description: Verbatim from that note.
verified:
type: boolean
description: True when the engine found the quote word for word in that note.
description: Examples from the notes.
description: Hooks.
formats:
type: array
items:
type: object
description: A format the notes use.
properties:
text:
type: string
description: The point, in the synthesis's language.
count:
type: integer
description: How many of the notes it was seen in.
examples:
type: array
items:
type: object
description: One example and the note it came from, checked by code.
properties:
note:
type: integer
description: 1-based index into the batch's read links, in order (the items with status done or cached).
quote:
type: string
description: Verbatim from that note.
verified:
type: boolean
description: True when the engine found the quote word for word in that note.
description: Examples from the notes.
description: Formats.
claims:
type: array
items:
type: object
description: A claim the notes make.
properties:
text:
type: string
description: The point, in the synthesis's language.
count:
type: integer
description: How many of the notes it was seen in.
examples:
type: array
items:
type: object
description: One example and the note it came from, checked by code.
properties:
note:
type: integer
description: 1-based index into the batch's read links, in order (the items with status done or cached).
quote:
type: string
description: Verbatim from that note.
verified:
type: boolean
description: True when the engine found the quote word for word in that note.
description: Examples from the notes.
description: Claims.
objections:
type: array
items:
type: object
description: An objection readers raise.
properties:
text:
type: string
description: The point, in the synthesis's language.
count:
type: integer
description: How many of the notes it was seen in.
examples:
type: array
items:
type: object
description: One example and the note it came from, checked by code.
properties:
note:
type: integer
description: 1-based index into the batch's read links, in order (the items with status done or cached).
quote:
type: string
description: Verbatim from that note.
verified:
type: boolean
description: True when the engine found the quote word for word in that note.
description: Examples from the notes.
description: Objections, from the comments when they were read.
gaps:
type: array
items:
type: object
description: Something none of the notes cover.
properties:
text:
type: string
description: The point, in the synthesis's language.
count:
type: integer
description: How many of the notes it was seen in.
examples:
type: array
items:
type: object
description: One example and the note it came from, checked by code.
properties:
note:
type: integer
description: 1-based index into the batch's read links, in order (the items with status done or cached).
quote:
type: string
description: Verbatim from that note.
verified:
type: boolean
description: True when the engine found the quote word for word in that note.
description: Examples from the notes.
description: Gaps.
missing:
type: array
items:
type: string
description: A section name.
description: The sections the material could not support.
raw_markdown:
type: string
description: The whole synthesis as Markdown (with the draft appended when one was asked for).
draft:
type:
- object
- 'null'
description: 成稿 — the post written from the batch (2026-10-31). Only on a batch that asked for draft=true; null while it runs. Every figure in it is in the notes. +1 credit once.
properties:
language:
type: string
description: The language it is written in.
platform:
type: string
description: xiaohongshu, douyin or en.
enum:
- xiaohongshu
- douyin
- en
titles:
type: array
items:
type: string
description: A title.
description: Three titles to pick from.
body:
type: string
description: The post itself, ready to paste.
hashtags:
type: array
items:
type: string
description: 'A hashtag without #.'
description: Hashtags.
cover_text:
type: string
description: The words for the cover image.
cites:
type: array
items:
type: integer
description: The notes (1-based, batch order) the draft draws on.
made_by:
type: string
description: '"model", "model_retry", or "fallback" (the notes'' own titles and key points, after two drafts carried figures not in the notes).'
cut:
type: integer
description: Sentences cut because their figure was not in any note.
Error:
type: object
description: An error.
properties:
error:
type: string
description: What went wrong, in a sentence.
error_code:
type:
- string
- 'null'
description: 'A stable code when there is one: platform_refused, not_served, quota_exceeded, insufficient_credits, media_too_long, not_found (no such path under /api/v1: the body lists the endpoints and names the one that was probably meant), method_not_allowed.'
how_to_read_now:
type:
- string
- 'null'
description: 'platform_refused only: what the caller can do instead, including the exact `linkdigest capture <file>` command.'
retryAfter:
type:
- integer
- 'null'
description: '429 only: seconds to wait, the same figure as the Retry-After header.'
running:
type: array
items:
type: object
description: A read of this account that is still running, or finished and not collected yet.
properties:
jobId:
type: string
description: The read's job id.
poll:
type: string
description: GET this with the same Authorization header to collect it; collecting frees the credits it holds.
description: '429 only, when credits held by reads still running are the reason: those reads, oldest first.'
next:
type:
- string
- 'null'
description: '429 with running: what to do, in a sentence (next_zh is the same in Chinese).'
Search:
type: object
description: Search results, and the batch over them when one was asked for.
properties:
query:
type: string
description: The topic, as searched.
platform:
type: string
description: Where it looked.
results:
type: array
items:
type: object
description: One result.
properties:
url:
type: string
description: A post link digest_url can read.
title:
type: string
description: Its title.
snippet:
type: string
description: Its summary line.
posted_at:
type:
- string
- 'null'
description: 'douyin and xiaohongshu: the day the post went up (YYYY-MM-DD, UTC), read from its id.'
description: 'The links found, in rank order: on douyin and xiaohongshu, the posts that carry the words searched, newest first.'
credits:
type: integer
description: 'What the search cost: 4 on douyin and xiaohongshu, 1 elsewhere, 0 when nothing was found.'
own_browser_url:
type:
- string
- 'null'
description: 'xiaohongshu only: the same search in the user''s own logged-in browser — the whole platform. The extension reads it there; GET /digest/batches?label=<query> picks the batch up.'
batch_id:
type:
- string
- 'null'
description: 'With digest: the batch started over the results.'
batch:
$ref: '#/components/schemas/Batch'
Batch:
type: object
description: A batch of links.
properties:
batch_id:
type: string
description: The batch id.
label:
type:
- string
- 'null'
description: What the batch was called, or null.
status:
type: string
description: running or done.
total:
type: integer
description: Links in the batch.
done:
type: integer
description: Finished.
failed:
type: integer
description: Failed.
credits_total:
type: integer
description: Credits spent so far.
poll:
type: string
description: The path to poll.
breakdown:
type: boolean
description: Whether every link is taken apart.
ask:
type:
- string
- 'null'
description: The question every link was asked, or null.
insight:
type: boolean
description: Whether every link's consumer insight was drawn.
depth:
type: string
description: 'full, transcript or script: how every video in the batch is read.'
enum:
- full
- transcript
- script
synthesis:
$ref: '#/components/schemas/Synthesis'
synthesis_credits:
type: integer
description: What the comparison cost (only on a batch that asked for synthesis).
synthesis_error:
type:
- string
- 'null'
description: Why the comparison failed, or null (only on a batch that asked for synthesis).
items:
type: array
items:
type: object
description: One link.
properties:
url:
type: string
description: The link.
status:
type: string
description: queued, running, done or error.
cache_key:
type: string
description: Where the digest is stored.
credits:
type: integer
description: What it cost.
error:
type: string
description: Why it failed, if it did.
description: Every link and its state.
securitySchemes:
bearer:
type: http
scheme: bearer
description: Your API key (ld_live_…) from https://linkdigest.dev/signin?ref=openapi&next=/app/keys.