LinkDigest · Schema
Batch
A batch of links.
Artificial IntelligenceSocial MediaData ExtractionSearchContent Aggregation
Properties
| Name | Type | Description |
|---|---|---|
| batch_id | string | The batch id. |
| label | stringnull | What the batch was called, or null. |
| status | string | running or done. |
| total | integer | Links in the batch. |
| done | integer | Finished. |
| failed | integer | Failed. |
| credits_total | integer | Credits spent so far. |
| poll | string | The path to poll. |
| breakdown | boolean | Whether every link is taken apart. |
| ask | stringnull | The question every link was asked, or null. |
| insight | boolean | Whether every link's consumer insight was drawn. |
| depth | string | full, transcript or script: how every video in the batch is read. |
| synthesis | object | |
| synthesis_credits | integer | What the comparison cost (only on a batch that asked for synthesis). |
| synthesis_error | stringnull | Why the comparison failed, or null (only on a batch that asked for synthesis). |
| items | array | Every link and its state. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/linkdigest-dev/json-schema/linkdigest-dev-batch-schema.json",
"title": "Batch",
"description": "A batch of links.",
"x-generated": "2026-11-17",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/linkdigest-dev-openapi.json#/components/schemas/Batch",
"type": "object",
"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": "#/$defs/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."
}
},
"$defs": {
"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."
}
}
},
"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."
}
}
},
"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."
}
}
},
"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."
}
}
},
"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."
}
}
},
"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."
}
}
},
"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."
}
}
}
}
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.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.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/linkdigest-dev-batch"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
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.
A second provider on the same verified email joins the account you already have.