Read public sources and manage a smry library, feeds, notes, highlights, files, and page monitors.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Atomically move, tag, mark read, update progress, or correct classification for up to 100 library items.
This tool isn't marked read-only, so it may change something on the server or in an account you connected.
Atomically move, tag, mark read, update progress, or correct classification for up to 100 library items.
| Argument | Type | Description |
|---|---|---|
| ids* | array | |
| tags | array | |
| status | any | |
| starred | boolean | |
| mark_read | boolean | |
| content_kind | any | |
| read_progress | any |
{
"type": "object",
"required": [
"ids"
],
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
"description": "UUID that identifies the resource; pass it back exactly as smry returned it."
},
"maxItems": 100,
"minItems": 1
},
"tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 32
},
"maxItems": 12
},
"status": {
"anyOf": [
{
"type": "string",
"const": "inbox"
},
{
"type": "string",
"const": "later"
},
{
"type": "string",
"const": "archive"
}
]
},
"starred": {
"type": "boolean"
},
"mark_read": {
"type": "boolean"
},
"content_kind": {
"anyOf": [
{
"type": "string",
"const": "article"
},
{
"type": "string",
"const": "website"
},
{
"type": "string",
"const": "book"
},
{
"type": "string",
"const": "email"
},
{
"type": "string",
"const": "pdf"
},
{
"type": "string",
"const": "social_post"
},
{
"type": "string",
"const": "video"
},
{
"type": "string",
"const": "podcast_episode"
},
{
"type": "string",
"const": "document"
},
{
"type": "string",
"const": "unknown"
}
]
},
"read_progress": {
"anyOf": [
{
"type": "integer",
"maximum": 99,
"minimum": 1
},
{
"type": "null"
}
]
}
},
"minProperties": 2,
"additionalProperties": false
}Create a scheduled web-change monitor whose detected changes arrive as an ordinary followed source — query, watch, and mutate it like any feed. Naming a collection that does not exist creates it. Active monitor limits are Free 3, Patron 10, and Pro 100; scheduled monthly credits are 150, 720, and 7,200, respectively. Page and sitemap runs reserve 1 credit; extract runs reserve 10. The shortest interval is 60 minutes and the default schedule is daily. The response reports remaining slots and scheduled credits. Example: {"name":"Example page changes","target":{"type":"page","url":"https://example.com"},"collection":"Research"}
| Argument | Type | Description |
|---|---|---|
| name* | string | |
| tags | array | |
| target* | any | "page" watches one URL, "sitemap" watches URL additions/removals, "extract" watches for meaningful site-wide changes per your instructions. |
| schedule | any | Default: daily. Shortest interval: 60 minutes. |
| collection | any | Collection id or name. A new name is created. Omit for Unsorted. |
| change_detection | any |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name",
"target"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 50,
"minLength": 1
},
"maxItems": 18
},
"target": {
"anyOf": [
{
"type": "object",
"required": [
"type",
"url"
],
"properties": {
"url": {
"type": "string",
"maxLength": 2048,
"minLength": 8,
"description": "A public http(s) URL."
},
"type": {
"type": "string",
"const": "page"
},
"instructions": {
"type": "string",
"maxLength": 2000,
"minLength": 1
},
"normalize_whitespace": {
"type": "boolean"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type",
"url"
],
"properties": {
"url": {
"type": "string",
"maxLength": 2048,
"minLength": 8,
"description": "A public http(s) URL."
},
"type": {
"type": "string",
"const": "sitemap"
},
"exclude": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"maxItems": 50
},
"include": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"maxItems": 50
},
"max_urls": {
"type": "integer",
"maximum": 10000,
"minimum": 1
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type",
"url",
"instructions"
],
"properties": {
"url": {
"type": "string",
"maxLength": 2048,
"minLength": 8,
"description": "A public http(s) URL."
},
"type": {
"type": "string",
"const": "extract"
},
"instructions": {
"type": "string",
"maxLength": 2000,
"minLength": 1
}
},
"additionalProperties": false
}
],
"description": "\"page\" watches one URL, \"sitemap\" watches URL additions/removals, \"extract\" watches for meaningful site-wide changes per your instructions."
},
"schedule": {
"anyOf": [
{
"type": "object",
"required": [
"type",
"frequency",
"unit"
],
"properties": {
"type": {
"type": "string",
"const": "interval"
},
"unit": {
"type": "string",
"const": "minutes"
},
"frequency": {
"type": "integer",
"maximum": 43200,
"minimum": 60
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type",
"frequency",
"unit"
],
"properties": {
"type": {
"type": "string",
"const": "interval"
},
"unit": {
"type": "string",
"const": "hours"
},
"frequency": {
"type": "integer",
"maximum": 720,
"minimum": 1
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type",
"frequency",
"unit"
],
"properties": {
"type": {
"type": "string",
"const": "interval"
},
"unit": {
"type": "string",
"const": "days"
},
"frequency": {
"type": "integer",
"maximum": 30,
"minimum": 1
}
},
"additionalProperties": false
}
],
"description": "Default: daily. Shortest interval: 60 minutes."
},
"collection": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1
},
{
"type": "string",
"maxLength": 100,
"minLength": 1
}
],
"description": "Collection id or name. A new name is created. Omit for Unsorted."
},
"change_detection": {
"anyOf": [
{
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"const": "exact"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"const": "semantic"
},
"confidence_threshold": {
"type": "number",
"maximum": 1,
"minimum": 0
}
},
"additionalProperties": false
}
]
}
},
"additionalProperties": false
}Creates a Collection-compatible news query. Google News RSS is the current adapter and is intentionally hidden behind this durable product type. Example: {"query":"open source databases","collection":"Research"}
| Argument | Type | Description |
|---|---|---|
| query* | string | |
| locale | string | |
| collection | any | Collection id or name. A new name is created. Omit for Unsorted. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"query"
],
"properties": {
"query": {
"type": "string",
"maxLength": 400,
"minLength": 2
},
"locale": {
"type": "string",
"maxLength": 10,
"minLength": 2
},
"collection": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1
},
{
"type": "string",
"maxLength": 100,
"minLength": 1
}
],
"description": "Collection id or name. A new name is created. Omit for Unsorted."
}
},
"additionalProperties": false
}Find public feeds by topic or find a site's published feeds. This is the compact Developer API discovery adapter; use search_feeds for language, ranking, and source-type controls. Discovery does not subscribe; pass result feedUrl values to follow_feeds. Example: {"query":"https://www.nasa.gov","mode":"site"}
| Argument | Type | Description |
|---|---|---|
| mode | any | "feeds" searches by topic; "site" discovers what a specific URL publishes. |
| query* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"query"
],
"properties": {
"mode": {
"anyOf": [
{
"type": "string",
"const": "feeds"
},
{
"type": "string",
"const": "site"
}
],
"description": "\"feeds\" searches by topic; \"site\" discovers what a specific URL publishes."
},
"query": {
"type": "string",
"maxLength": 2048,
"minLength": 2
}
},
"additionalProperties": false
}Follow up to 20 feed or site URLs in one call. Site URLs are resolved to their published feed. Naming a collection that does not exist creates it. Returns a per-URL outcome — partial success is normal and legible, never all-or-nothing. Example: {"urls":["https://www.nasa.gov/feed/"],"collection":"Research"}
| Argument | Type | Description |
|---|---|---|
| urls* | array | |
| collection | any | Collection id or name. A new name is created. Omit for Unsorted. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"urls"
],
"properties": {
"urls": {
"type": "array",
"items": {
"type": "string",
"maxLength": 2048,
"minLength": 8
},
"maxItems": 20,
"minItems": 1
},
"collection": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1
},
{
"type": "string",
"maxLength": 100,
"minLength": 1
}
],
"description": "Collection id or name. A new name is created. Omit for Unsorted."
}
},
"additionalProperties": false
}Fetch clean, source-grounded text for a public article or YouTube URL, budgeted to a token limit and addressable by paragraph anchor. Returns an outline of headings (empty when the source has none), the requested window, and a next_cursor when more remains. Prefer search_article when you have a specific question rather than needing the whole text.
| Argument | Type | Description |
|---|---|---|
| url* | string | |
| cursor | integer | |
| max_tokens | integer |
{
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"format": "uri",
"maxLength": 4096
},
"cursor": {
"type": "integer",
"minimum": 1
},
"max_tokens": {
"type": "integer",
"maximum": 25000,
"minimum": 100
}
},
"additionalProperties": false
}One stream, two checkpoint owners. Stateful callers pass cursor:"latest", then store each next_cursor themselves; that first call only establishes the checkpoint and returns no events, so poll again with the returned next_cursor. Stateless scheduled agents pass consumer_id; smry retains the acknowledged position and the consumer's saved where predicate. Pass exactly one. Managed batches repeat until their next_cursor is acknowledged. Every response also carries a capped source-health attention block. To read what is already there rather than what changes next, use query_feeds. Example: {"cursor":"latest","limit":20} Example: {"consumer_id":7,"limit":20}
| Argument | Type | Description |
|---|---|---|
| limit | integer | |
| where | object | Entry selection predicate: fields AND together; omit a field to not filter on it. Source queries/mutations accept only collection and source; use query having for source-health filters. |
| cursor | string | Caller-managed progress: "latest" to start, then the next_cursor you stored. |
| fields | array | Project event entries to these fields; ["id"] is the cheapest diff. id is always included. |
| consumer_id | integer | smry-managed progress: poll this consumer's saved predicate. Omit cursor and where. |
| attention_limit | integer | Sources listed per attention bucket (default 5; the *_count fields always carry the full tally). Pass up to 500 for the exhaustive roster, 0 for counts only. |
Return an authenticated MCP resource link for an item's original file. Set include_data=true to show images or audio inline, or embed another file up to 8 MiB. Larger originals remain readable through the streaming Developer API byte-range endpoint.
| Argument | Type | Description |
|---|---|---|
| id* | string | UUID that identifies the resource; pass it back exactly as smry returned it. |
| include_data | boolean |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
"description": "UUID that identifies the resource; pass it back exactly as smry returned it."
},
"include_data": {
"type": "boolean"
}
},
"additionalProperties": false
}Read the append-only library change stream, including deletions. For a race-free first sync, call once with cursor=latest, list the library, then continue from the returned nextCursor.
| Argument | Type | Description |
|---|---|---|
| limit | number | Maximum changes to return in this page, from 1 to 250. Defaults to 100. |
| cursor | string | Pass a previous response's nextCursor verbatim, or latest to start at the current head; never construct one. |
{
"type": "object",
"properties": {
"limit": {
"type": "number",
"maximum": 250,
"minimum": 1,
"multipleOf": 1,
"description": "Maximum changes to return in this page, from 1 to 250. Defaults to 100."
},
"cursor": {
"type": "string",
"maxLength": 500,
"description": "Pass a previous response's nextCursor verbatim, or latest to start at the current head; never construct one."
}
},
"additionalProperties": false
}Read one object returned by list_library_objects. Item text and note/highlight bodies are bounded; item asset metadata includes the MCP resource URI for original bytes.
| Argument | Type | Description |
|---|---|---|
| ref* | string | |
| content_max_characters | number | Maximum characters of object text to return, from 500 to 12000. Defaults to 12000. |
{
"type": "object",
"required": [
"ref"
],
"properties": {
"ref": {
"type": "string",
"maxLength": 1000,
"minLength": 3
},
"content_max_characters": {
"type": "number",
"maximum": 12000,
"minimum": 500,
"multipleOf": 1,
"description": "Maximum characters of object text to return, from 500 to 12000. Defaults to 12000."
}
},
"additionalProperties": false
}Read one library item by id. Stored article text is token-budgeted and supports a paragraph cursor so long documents never flood the agent context.
| Argument | Type | Description |
|---|---|---|
| id* | string | UUID that identifies the resource; pass it back exactly as smry returned it. |
| cursor | integer | |
| max_tokens | integer | |
| include_content | boolean | Include the item's stored article text. Defaults to true. |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
"description": "UUID that identifies the resource; pass it back exactly as smry returned it."
},
"cursor": {
"type": "integer",
"minimum": 0
},
"max_tokens": {
"type": "integer",
"maximum": 25000,
"minimum": 100
},
"include_content": {
"type": "boolean",
"default": true,
"description": "Include the item's stored article text. Defaults to true."
}
},
"additionalProperties": false
}Search this account's articles, websites, books, emails, PDFs, social posts, videos, podcast episodes, and documents. For a normal text search, pass only query and limit. "Triage my inbox" is {"status":"inbox","limit":10}; "saved this week" is {"saved_after":"7d"}. Matching is shared with app search and REST, including spelling recovery (approximate=true). Optional filters are combined with AND: omit every filter the user did not explicitly request. Filter by exact tag, kind, capture method, format, or lifecycle; set view=history for recently read items. Items are ordered by most recent status change first (history view: last read first); continue with nextCursor. Item IDs select later tools and are not smry.ai routes; cite only each exact returned source URL.
| Argument | Type | Description |
|---|---|---|
| tag | string | Return only items carrying this tag, matching without regard to case or surrounding spaces. |
| view | any | Set history for reading history, the only way to read it; defaults to all saved items. |
| limit | number | Maximum items to return, from 1 to 100. Defaults to 50, and is capped at 20 with includeContent. |
| query | string | Full-text search over saved titles and text; omit to list without searching. |
| cursor | string | Opaque page token: pass the previous response's nextCursor verbatim and never construct one. |
| format | any |
Search and paginate across the account's saved items, standalone notes, and highlights through one corpus. Uses the same Postgres matching as the app and REST API; approximate=true identifies spelling recovery. Returns stable refs for get_library_object. Use list_library when you specifically need item lifecycle filters or reading history.
| Argument | Type | Description |
|---|---|---|
| limit | number | Maximum objects to return in this page, from 1 to 100. Defaults to 50. |
| query | string | Full-text search across saved items, notes, and highlights; omit to list the whole corpus. |
| types | array | |
| cursor | string | Opaque page token: pass the previous response's nextCursor verbatim and never construct one. |
{
"type": "object",
"properties": {
"limit": {
"type": "number",
"maximum": 100,
"minimum": 1,
"multipleOf": 1,
"description": "Maximum objects to return in this page, from 1 to 100. Defaults to 50."
},
"query": {
"type": "string",
"maxLength": 500,
"description": "Full-text search across saved items, notes, and highlights; omit to list the whole corpus."
},
"types": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"const": "item"
},
{
"type": "string",
"const": "note"
},
{
"type": "string",
"const": "highlight"
}
]
},
"maxItems": 3,
"minItems": 1
},
"cursor": {
"type": "string",
"maxLength": 1000,
"description": "Opaque page token: pass the previous response's nextCursor verbatim and never construct one."
}
},
"additionalProperties": false
}list: Returns the same owner-scoped Collections shown in /feeds, including canonical filter state and revision. Required fields: none. Example: {"action":"list"} create: Creates the same named Collection used by the production /feeds UI. Required fields: name. Example: {"action":"create","name":"Research"} update: Membership is a complete replacement, matching the production Collection editor. Required fields: id. Example: {"action":"update","id":12,"name":"Engineering"} delete: Deletes a custom Collection and moves its inputs to Unsorted. Required fields: id. Example: {"action":"delete","id":12}
| Argument | Type | Description |
|---|---|---|
| id | integer | |
| name | string | |
| action* | string | "list": List Collections and their managed-feed filters · "create": Create a Collection · "update": Rename a Collection or replace its input membership · "delete": Delete a Collection |
| source_ids | array |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"action"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1
},
"name": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"action": {
"enum": [
"list",
"create",
"update",
"delete"
],
"type": "string",
"description": "\"list\": List Collections and their managed-feed filters · \"create\": Create a Collection · \"update\": Rename a Collection or replace its input membership · \"delete\": Delete a Collection"
},
"source_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1
},
"maxItems": 1000
}
},
"additionalProperties": false
}create: Save a where predicate and let smry retain one processing checkpoint. New consumers start at the current high-water mark, so they receive future discoveries rather than replaying history. For history, create the Consumer first, query the historical window separately, then poll; that order closes the query/create race. Create one per independent processing loop, not per source. Retrying the same case-insensitive name and predicate returns the existing Consumer; the same name with another predicate is a 409. Required fields: name. Example: {"action":"create","name":"Engineering briefing","where":{"collection":["Research"]}} list: List each saved consumer, its opaque acknowledged_cursor, delivery and acknowledgement timestamps, and how many matching entries are waiting past that checkpoint. Required fields: none. Example: {"action":"list"} ack: After processing every event returned by getFeedChanges for this consumer, acknowledge that response's next_cursor. Crashes before ack cause safe redelivery; stale, foreign, and invented cursors are rejected. Required fields: id, cursor. Example: {"action":"ack","id":7,"cursor":"<next_cursor from get_feed_changes>"} delete: Remove only the saved predicate and checkpoint. Followed sources, entries, and human read state are untouched. Required fields: id. Example: {"action":"delete","id":7}
| Argument | Type | Description |
|---|---|---|
| id | integer | |
| name | string | |
| where | object | Entry selection predicate: fields AND together; omit a field to not filter on it. Source queries/mutations accept only collection and source; use query having for source-health filters. |
| action* |
preview: Classifies a bounded recent sample and returns both binary decisions, uncertainty counts, reasons, and degradation status. Save with applyFeedFilter using this preview token and Collection revision. Required fields: collection, filter. Example: {"action":"preview","collection":{"id":12},"filter":{"prompt":"Software engineering articles","whenUncertain":"include"}} apply: Atomically applies the exact preview when the Collection revision still matches. Passing a preview created with filter:null clears the filter. Required fields: previewToken, expectedRevision. Example: {"action":"apply","previewToken":"<previewToken from preview>","expectedRevision":0}
| Argument | Type | Description |
|---|---|---|
| action* | string | "preview": Preview a Collection filter without changing the feed · "apply": Apply a previously previewed Collection filter |
| filter | any | |
| collection | object | |
| previewToken | string | |
| expectedRevision | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"action"
],
"properties": {
"action": {
"enum": [
"preview",
"apply"
],
"type": "string",
"description": "\"preview\": Preview a Collection filter without changing the feed · \"apply\": Apply a previously previewed Collection filter"
},
"filter": {
"anyOf": [
{
"type": "object",
"required": [
"prompt",
"whenUncertain"
],
"properties": {
"prompt": {
"type": "string",
"maxLength": 700,
"minLength": 1
},
"whenUncertain": {
"anyOf": [
{
"type": "string",
"const": "include"
},
{
"type": "string",
"const": "exclude"
}
]
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"prompt",
"uncertaintyPolicy"
],
"properties": {
"prompt": {
"type": "string",
"maxLength": 700,
"minLength": 1
},
"uncertaintyPolicy": {
"anyOf": [
{
"type": "string",
"const": "include_for_review"
},
{
"type": "string",
"const": "exclude"
}
]
}
},
"description": "Deprecated for one SDK release. include_for_review normalizes to whenUncertain:include; no review queue is created.",
"additionalProperties": false
},
{
"type": "null"
}
]
},
"collection": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1
}
},
"additionalProperties": false
},
"previewToken": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"expectedRevision": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": false
}Preview changes to matching sources, entries, or collections. Default dry_run:true returns would_affect, sample, and commit_token without changing them. Commit by sending the same op and commit_token; retries replay the recorded result. Explicit dry_run:false applies immediately. sources.move needs set.collection; sources.rename needs set.title; collections.create/rename need set.name. Collections rename/delete need exactly one where.collection. Use manage_collections for direct collection CRUD. Check partial and each outcome after committing. Example: {"op":"collections.create","set":{"name":"Research"}} Example: {"op":"sources.move","where":{"source":{"include":[42]}},"set":{"collection":"Research"}} Example: {"op":"sources.move","commit_token":"<commit_token from preview>"}
| Argument | Type | Description |
|---|---|---|
| op* | any | sources.* use where.source or where.collection, never entry filters. entries.* use the full where predicate. collections.rename/delete select one where.collection; collections.create uses set.name. |
| set | object | |
| where | object | Entry selection predicate: fields AND together; omit a field to not filter on it. Source queries/mutations accept only collection and source; use query having for source-health filters. |
| dry_run | boolean | Default true: preview affected records and return a commit_token. Explicit false applies immediately; prefer preview then commit_token for agent workflows. |
| commit_token | string |
Open up to four public pages. Pass a focused context to get only the passages relevant to that question (cheap and precise), or omit it to read the full page as clean Markdown with start-based pagination.
| Argument | Type | Description |
|---|---|---|
| pages* | array |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"pages"
],
"properties": {
"pages": {
"type": "array",
"items": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"live": {
"type": "boolean"
},
"start": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"context": {
"type": "string",
"maxLength": 2000,
"minLength": 1
}
}
},
"maxItems": 4,
"minItems": 1
}
}
}Read followed feeds. "What's new?" is {"since":"1d"}: newest published first, one line per entry with format:"compact". Other arguments are optional; add where.collection, where.source.include/exclude, where.unread, or where.match when requested. per_source_limit produces a bounded fair sample across pages; omit it to retrieve every matching article. select:"sources" returns fetch_status and last_fetched_at separately from publisher activity (health, silent_days, entries_7d/28d). Quiet publishers can have working feeds. select:"aggregate" returns grouped counts with optional trends. Classification-filtered queries report classification_coverage: pending articles have not been assessed, not rejected. Times accept "7d"/"36h"/"now" or ISO dates. Example: {"since":"1d","per_source_limit":3,"limit":40,"format":"compact"} Example: {"select":"entries","where":{"unread":true,"collection":["Research"]},"limit":10} Example: {"select":"sources","having":{"silent_days":{"gte":30}},"limit":10} Example: {"select":"aggregate","group_by":"collection","where":{"discovered_after":"7d"}}
| Argument | Type | Description |
|---|---|---|
| limit | integer | Default 20, maximum 100; page further with next_cursor. |
| since | string | The "what's new" shorthand: entries published after this time (falling back to discovery time when the feed gives none), newest published first. {"since":"1d"} is the whole catch-up call. Entries only. |
| where | object | Entry selection predicate: fields AND together; omit a field to not filter on it. Source queries/mutations accept only collection and source; use query having for source-health filters. |
| cursor | string |
Remove one item from this account's library. Web sources are unaffected. For an uploaded file, its original, extracted text, and synced local copies are permanently deleted; highlights and notes are kept.
| Argument | Type | Description |
|---|---|---|
| id* | string | UUID that identifies the resource; pass it back exactly as smry returned it. |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
"description": "UUID that identifies the resource; pass it back exactly as smry returned it."
}
},
"additionalProperties": false
}Securely extract a public URL and idempotently add it to the account's library. Returns alreadySaved=true for a duplicate and reports hard paywalls instead of claiming success.
| Argument | Type | Description |
|---|---|---|
| url* | string | |
| tags | array | |
| status | any | |
| starred | boolean |
{
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"format": "uri",
"maxLength": 4096
},
"tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 32
},
"maxItems": 12
},
"status": {
"anyOf": [
{
"type": "string",
"const": "inbox"
},
{
"type": "string",
"const": "later"
},
{
"type": "string",
"const": "archive"
}
]
},
"starred": {
"type": "boolean"
}
},
"additionalProperties": false
}Save supplied source text without fetching a public URL. Use external_id for retry-safe creates; content_kind can correct automatic classification.
| Argument | Type | Description |
|---|---|---|
| url | string | |
| tags | array | |
| title* | string | |
| author | any | |
| format | any | |
| status | any | |
| content* | string | |
| starred | boolean | |
| metadata | object | |
| file_name | any | |
| mime_type | any | |
| external_id | any |
Read a public article or YouTube URL and return only the passages relevant to your query, each anchored to its paragraph and labelled with the section it sits under. Use this instead of get_article whenever you have a specific question about a link — it answers in a fraction of the tokens and the anchors stay citable.
| Argument | Type | Description |
|---|---|---|
| url* | string | |
| query* | string | |
| cursor | integer | |
| max_tokens | integer | |
| max_passages | integer |
{
"type": "object",
"required": [
"url",
"query"
],
"properties": {
"url": {
"type": "string",
"format": "uri",
"maxLength": 4096
},
"query": {
"type": "string",
"maxLength": 500,
"minLength": 1
},
"cursor": {
"type": "integer",
"minimum": 0
},
"max_tokens": {
"type": "integer",
"maximum": 25000,
"minimum": 100
},
"max_passages": {
"type": "integer",
"maximum": 25,
"minimum": 1
}
},
"additionalProperties": false
}Use the same discovery catalog and ranking as smry's Discover feeds page. Browse suggested sources with no query; search websites, RSS, Atom, podcasts, Reddit, and YouTube by topic; create a focused Google News source; or discover every feed published by a site URL. Use sort=popular for popularity ordering. This only discovers sources; use follow_feeds to follow results in an existing or new collection.
| Argument | Type | Description |
|---|---|---|
| mode | string | Discover source type. "feeds" is a compatibility alias for "websites". Use "url" when query is a site or feed URL. Default: all. |
| sort | string | Rank by best match or popularity. Default: best. |
| limit | integer | Maximum results. Defaults match the Discover page. |
| query | string | Topic, publication, community, channel, podcast, or site URL. Omit to browse suggested sources. |
| language | string | Source language. Default: English (en). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"mode": {
"enum": [
"all",
"websites",
"feeds",
"podcasts",
"reddit",
"youtube",
"url"
],
"type": "string",
"description": "Discover source type. \"feeds\" is a compatibility alias for \"websites\". Use \"url\" when query is a site or feed URL. Default: all."
},
"sort": {
"enum": [
"best",
"popular"
],
"type": "string",
"description": "Rank by best match or popularity. Default: best."
},
"limit": {
"type": "integer",
"maximum": 50,
"minimum": 1,
"description": "Maximum results. Defaults match the Discover page."
},
"query": {
"type": "string",
"maxLength": 2048,
"description": "Topic, publication, community, channel, podcast, or site URL. Omit to browse suggested sources."
},
"language": {
"enum": [
"en",
"pt",
"de",
"zh",
"es",
"nl"
],
"type": "string",
"description": "Source language. Default: English (en)."
}
}
}Return only the stored passages relevant to a question about one library item. Use after list_library instead of reading a long book, PDF, email, transcript, or document from the beginning.
| Argument | Type | Description |
|---|---|---|
| id* | string | UUID that identifies the resource; pass it back exactly as smry returned it. |
| query* | string | |
| cursor | integer | |
| max_tokens | integer | |
| max_passages | integer |
{
"type": "object",
"required": [
"id",
"query"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
"description": "UUID that identifies the resource; pass it back exactly as smry returned it."
},
"query": {
"type": "string",
"maxLength": 500,
"minLength": 1
},
"cursor": {
"type": "integer",
"minimum": 0
},
"max_tokens": {
"type": "integer",
"maximum": 25000,
"minimum": 100
},
"max_passages": {
"type": "integer",
"maximum": 25,
"minimum": 1
}
},
"additionalProperties": false
}Discover current public sources with up to four focused searches. Search snippets are discovery aids; open the strongest pages before citing substantive claims.
| Argument | Type | Description |
|---|---|---|
| queries* | array | |
| max_results | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"queries"
],
"properties": {
"queries": {
"type": "array",
"items": {
"type": "object",
"required": [
"query"
],
"properties": {
"site": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"query": {
"type": "string",
"maxLength": 500,
"minLength": 2
},
"publishedAfter": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"publishedBefore": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
}
}
},
"maxItems": 4,
"minItems": 1
},
"max_results": {
"type": "integer",
"maximum": 8,
"minimum": 1
}
}
}Less like this hides an included entry. Feedback remains separate agent context and never silently revises the Collection filter. Example: {"entryId":42,"value":"less_like_this"}
| Argument | Type | Description |
|---|---|---|
| value* | any | |
| entryId* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"entryId",
"value"
],
"properties": {
"value": {
"anyOf": [
{
"type": "string",
"const": "more_like_this"
},
{
"type": "string",
"const": "less_like_this"
},
{
"type": "null"
}
]
},
"entryId": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1
}
},
"additionalProperties": false
}Move, tag, mark read, update progress, or correct the classification of one library item.
| Argument | Type | Description |
|---|---|---|
| id* | string | UUID that identifies the resource; pass it back exactly as smry returned it. |
| tags | array | |
| status | any | |
| starred | boolean | |
| mark_read | boolean | |
| content_kind | any | |
| read_progress | any |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
"description": "UUID that identifies the resource; pass it back exactly as smry returned it."
},
"tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 32
},
"maxItems": 12
},
"status": {
"anyOf": [
{
"type": "string",
"const": "inbox"
},
{
"type": "string",
"const": "later"
},
{
"type": "string",
"const": "archive"
}
]
},
"starred": {
"type": "boolean"
},
"mark_read": {
"type": "boolean"
},
"content_kind": {
"anyOf": [
{
"type": "string",
"const": "article"
},
{
"type": "string",
"const": "website"
},
{
"type": "string",
"const": "book"
},
{
"type": "string",
"const": "email"
},
{
"type": "string",
"const": "pdf"
},
{
"type": "string",
"const": "social_post"
},
{
"type": "string",
"const": "video"
},
{
"type": "string",
"const": "podcast_episode"
},
{
"type": "string",
"const": "document"
},
{
"type": "string",
"const": "unknown"
}
]
},
"read_progress": {
"anyOf": [
{
"type": "integer",
"maximum": 99,
"minimum": 1
},
{
"type": "null"
}
]
}
},
"minProperties": 2,
"additionalProperties": false
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1
},
"where": {
"type": "object",
"properties": {
"match": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Case-insensitive text match over title and summary. \"a OR b\" matches either."
},
"source": {
"type": "object",
"properties": {
"exclude": {
"type": "array",
"items": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1
},
{
"type": "string",
"maxLength": 500,
"minLength": 1
}
],
"description": "A source id (from any v2 response) or its title. Reads also accept a fragment that matches exactly one title."
},
"maxItems": 100,
"minItems": 1
},
"include": {
"type": "array",
"items": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1
},
{
"type": "string",
"maxLength": 500,
"minLength": 1
}
],
"description": "A source id (from any v2 response) or its title. Reads also accept a fragment that matches exactly one title."
},
"maxItems": 100,
"minItems": 1
}
},
"additionalProperties": false
},
"unread": {
"type": "boolean",
"description": "true = only unread entries, false = only read entries."
},
"collection": {
"type": "array",
"items": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1
},
{
"type": "string",
"maxLength": 100,
"minLength": 1
}
],
"description": "A collection id or its exact name."
},
"maxItems": 20,
"minItems": 1
},
"classification": {
"type": "object",
"required": [
"decision"
],
"properties": {
"decision": {
"anyOf": [
{
"type": "string",
"const": "include"
},
{
"type": "string",
"const": "exclude"
}
]
},
"assessment": {
"anyOf": [
{
"type": "string",
"const": "relevant"
},
{
"type": "string",
"const": "irrelevant"
},
{
"type": "string",
"const": "uncertain"
}
]
}
},
"description": "The Collection filter's binary delivery decision and optional underlying assessment. Requires exactly one Collection.",
"additionalProperties": false
},
"published_after": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "When the source published the entry (entries with no publish date are excluded; use top-level since to include them). Relative window (\"7d\", \"36h\", \"45m\", \"2w\"), \"now\", or ISO date."
},
"discovered_after": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "When smry first saw the entry. Backfill makes old posts look new here, so use it for diffs, not for \"what's new\". Relative window (\"7d\", \"36h\", \"45m\", \"2w\"), \"now\", or ISO date."
},
"published_before": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Relative window (\"7d\", \"36h\", \"45m\", \"2w\"), \"now\", or ISO date."
},
"discovered_before": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Relative window (\"7d\", \"36h\", \"45m\", \"2w\"), \"now\", or ISO date."
}
},
"description": "Entry selection predicate: fields AND together; omit a field to not filter on it. Source queries/mutations accept only collection and source; use query having for source-health filters.",
"additionalProperties": false
},
"cursor": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Caller-managed progress: \"latest\" to start, then the next_cursor you stored."
},
"fields": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"const": "id"
},
{
"type": "string",
"const": "source"
},
{
"type": "string",
"const": "source_id"
},
{
"type": "string",
"const": "collection"
},
{
"type": "string",
"const": "title"
},
{
"type": "string",
"const": "url"
},
{
"type": "string",
"const": "summary"
},
{
"type": "string",
"const": "author"
},
{
"type": "string",
"const": "image_url"
},
{
"type": "string",
"const": "published_at"
},
{
"type": "string",
"const": "discovered_at"
},
{
"type": "string",
"const": "unread"
},
{
"type": "string",
"const": "classification"
},
{
"type": "string",
"const": "feedback"
}
]
},
"description": "Project event entries to these fields; [\"id\"] is the cheapest diff. id is always included."
},
"consumer_id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "smry-managed progress: poll this consumer's saved predicate. Omit cursor and where."
},
"attention_limit": {
"type": "integer",
"maximum": 500,
"minimum": 0,
"description": "Sources listed per attention bucket (default 5; the *_count fields always carry the full tally). Pass up to 500 for the exhaustive roster, 0 for counts only."
}
},
"additionalProperties": false
}| Return only items stored in this format, such as html, pdf, or epub. |
| status | any | Return only items in this triage status: inbox, later, or archive. |
| starred | boolean | Set true for starred items only, or false for unstarred items only. |
| external_id | string | Return only the item saved under this external id from your own system. |
| saved_after | string | Items saved after this time: "7d", "36h", "now", or an ISO date. Use for "saved this week". |
| content_kind | any | Return only items of this content kind, such as article, pdf, or video. |
| updated_after | string | Items whose record changed after this time (status, tags, read progress, or a save): "7d", "36h", "now", or an ISO date. For "saved this week" use savedAfter. |
| capture_method | any | Return only items captured this way, such as reader, extension, upload, or api. |
| include_counts | boolean |
| include_content | boolean | Include each item's stored article text. Defaults to false. |
| include_metadata | boolean | Include the free-form metadata object saved through the API. Everything else is always returned. |
| content_max_characters | number | Maximum characters of text per item when includeContent is set, from 500 to 12000. Defaults to 4000. |
{
"type": "object",
"properties": {
"tag": {
"type": "string",
"maxLength": 32,
"minLength": 1,
"description": "Return only items carrying this tag, matching without regard to case or surrounding spaces."
},
"view": {
"anyOf": [
{
"type": "string",
"const": "all"
},
{
"type": "string",
"const": "history"
}
],
"description": "Set history for reading history, the only way to read it; defaults to all saved items."
},
"limit": {
"type": "number",
"maximum": 100,
"minimum": 1,
"multipleOf": 1,
"description": "Maximum items to return, from 1 to 100. Defaults to 50, and is capped at 20 with includeContent."
},
"query": {
"type": "string",
"maxLength": 500,
"description": "Full-text search over saved titles and text; omit to list without searching."
},
"cursor": {
"type": "string",
"maxLength": 500,
"description": "Opaque page token: pass the previous response's nextCursor verbatim and never construct one."
},
"format": {
"anyOf": [
{
"type": "string",
"const": "html"
},
{
"type": "string",
"const": "pdf"
},
{
"type": "string",
"const": "epub"
},
{
"type": "string",
"const": "markdown"
},
{
"type": "string",
"const": "plain_text"
},
{
"type": "string",
"const": "document"
},
{
"type": "string",
"const": "spreadsheet"
},
{
"type": "string",
"const": "presentation"
},
{
"type": "string",
"const": "audio"
},
{
"type": "string",
"const": "video"
},
{
"type": "string",
"const": "unknown"
}
],
"description": "Return only items stored in this format, such as html, pdf, or epub."
},
"status": {
"anyOf": [
{
"type": "string",
"const": "inbox"
},
{
"type": "string",
"const": "later"
},
{
"type": "string",
"const": "archive"
}
],
"description": "Return only items in this triage status: inbox, later, or archive."
},
"starred": {
"type": "boolean",
"description": "Set true for starred items only, or false for unstarred items only."
},
"external_id": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Return only the item saved under this external id from your own system."
},
"saved_after": {
"type": "string",
"maxLength": 80,
"description": "Items saved after this time: \"7d\", \"36h\", \"now\", or an ISO date. Use for \"saved this week\"."
},
"content_kind": {
"anyOf": [
{
"type": "string",
"const": "article"
},
{
"type": "string",
"const": "website"
},
{
"type": "string",
"const": "book"
},
{
"type": "string",
"const": "email"
},
{
"type": "string",
"const": "pdf"
},
{
"type": "string",
"const": "social_post"
},
{
"type": "string",
"const": "video"
},
{
"type": "string",
"const": "podcast_episode"
},
{
"type": "string",
"const": "document"
},
{
"type": "string",
"const": "unknown"
}
],
"description": "Return only items of this content kind, such as article, pdf, or video."
},
"updated_after": {
"type": "string",
"maxLength": 80,
"description": "Items whose record changed after this time (status, tags, read progress, or a save): \"7d\", \"36h\", \"now\", or an ISO date. For \"saved this week\" use savedAfter."
},
"capture_method": {
"anyOf": [
{
"type": "string",
"const": "reader"
},
{
"type": "string",
"const": "extension"
},
{
"type": "string",
"const": "upload"
},
{
"type": "string",
"const": "rss"
},
{
"type": "string",
"const": "email_inbox"
},
{
"type": "string",
"const": "api"
},
{
"type": "string",
"const": "import"
}
],
"description": "Return only items captured this way, such as reader, extension, upload, or api."
},
"include_counts": {
"type": "boolean"
},
"include_content": {
"type": "boolean",
"description": "Include each item's stored article text. Defaults to false."
},
"include_metadata": {
"type": "boolean",
"description": "Include the free-form metadata object saved through the API. Everything else is always returned."
},
"content_max_characters": {
"type": "number",
"maximum": 12000,
"minimum": 500,
"multipleOf": 1,
"description": "Maximum characters of text per item when includeContent is set, from 500 to 12000. Defaults to 4000."
}
},
"additionalProperties": false
}| string |
| "create": Create a managed feed consumer · "list": List managed consumers with pending counts · "ack": Acknowledge a managed consumer batch · "delete": Delete a managed feed consumer |
| cursor | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"action"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1
},
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"where": {
"type": "object",
"properties": {
"match": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Case-insensitive text match over title and summary. \"a OR b\" matches either."
},
"source": {
"type": "object",
"properties": {
"exclude": {
"type": "array",
"items": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1
},
{
"type": "string",
"maxLength": 500,
"minLength": 1
}
],
"description": "A source id (from any v2 response) or its title. Reads also accept a fragment that matches exactly one title."
},
"maxItems": 100,
"minItems": 1
},
"include": {
"type": "array",
"items": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1
},
{
"type": "string",
"maxLength": 500,
"minLength": 1
}
],
"description": "A source id (from any v2 response) or its title. Reads also accept a fragment that matches exactly one title."
},
"maxItems": 100,
"minItems": 1
}
},
"additionalProperties": false
},
"unread": {
"type": "boolean",
"description": "true = only unread entries, false = only read entries."
},
"collection": {
"type": "array",
"items": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1
},
{
"type": "string",
"maxLength": 100,
"minLength": 1
}
],
"description": "A collection id or its exact name."
},
"maxItems": 20,
"minItems": 1
},
"classification": {
"type": "object",
"required": [
"decision"
],
"properties": {
"decision": {
"anyOf": [
{
"type": "string",
"const": "include"
},
{
"type": "string",
"const": "exclude"
}
]
},
"assessment": {
"anyOf": [
{
"type": "string",
"const": "relevant"
},
{
"type": "string",
"const": "irrelevant"
},
{
"type": "string",
"const": "uncertain"
}
]
}
},
"description": "The Collection filter's binary delivery decision and optional underlying assessment. Requires exactly one Collection.",
"additionalProperties": false
},
"published_after": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "When the source published the entry (entries with no publish date are excluded; use top-level since to include them). Relative window (\"7d\", \"36h\", \"45m\", \"2w\"), \"now\", or ISO date."
},
"discovered_after": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "When smry first saw the entry. Backfill makes old posts look new here, so use it for diffs, not for \"what's new\". Relative window (\"7d\", \"36h\", \"45m\", \"2w\"), \"now\", or ISO date."
},
"published_before": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Relative window (\"7d\", \"36h\", \"45m\", \"2w\"), \"now\", or ISO date."
},
"discovered_before": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Relative window (\"7d\", \"36h\", \"45m\", \"2w\"), \"now\", or ISO date."
}
},
"description": "Entry selection predicate: fields AND together; omit a field to not filter on it. Source queries/mutations accept only collection and source; use query having for source-health filters.",
"additionalProperties": false
},
"action": {
"enum": [
"create",
"list",
"ack",
"delete"
],
"type": "string",
"description": "\"create\": Create a managed feed consumer · \"list\": List managed consumers with pending counts · \"ack\": Acknowledge a managed consumer batch · \"delete\": Delete a managed feed consumer"
},
"cursor": {
"type": "string",
"maxLength": 500,
"minLength": 1
}
},
"additionalProperties": false
}| From a dry run. Single-use and idempotent: resending after a network failure replays the recorded outcome. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"op"
],
"properties": {
"op": {
"anyOf": [
{
"type": "string",
"const": "sources.unfollow"
},
{
"type": "string",
"const": "sources.move"
},
{
"type": "string",
"const": "sources.rename"
},
{
"type": "string",
"const": "entries.mark_read"
},
{
"type": "string",
"const": "entries.mark_unread"
},
{
"type": "string",
"const": "collections.create"
},
{
"type": "string",
"const": "collections.rename"
},
{
"type": "string",
"const": "collections.delete"
}
],
"description": "sources.* use where.source or where.collection, never entry filters. entries.* use the full where predicate. collections.rename/delete select one where.collection; collections.create uses set.name."
},
"set": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Required for collections.create and collections.rename: the collection name."
},
"title": {
"type": "string",
"maxLength": 300,
"minLength": 1,
"description": "Required for sources.rename: the new source title."
},
"collection": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1
},
{
"type": "string",
"minLength": 1
}
],
"description": "Required for sources.move: destination collection id or name."
}
},
"additionalProperties": false
},
"where": {
"type": "object",
"properties": {
"match": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Case-insensitive text match over title and summary. \"a OR b\" matches either."
},
"source": {
"type": "object",
"properties": {
"exclude": {
"type": "array",
"items": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1
},
{
"type": "string",
"maxLength": 500,
"minLength": 1
}
],
"description": "A source id (from any v2 response) or its title. Reads also accept a fragment that matches exactly one title."
},
"maxItems": 100,
"minItems": 1
},
"include": {
"type": "array",
"items": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1
},
{
"type": "string",
"maxLength": 500,
"minLength": 1
}
],
"description": "A source id (from any v2 response) or its title. Reads also accept a fragment that matches exactly one title."
},
"maxItems": 100,
"minItems": 1
}
},
"additionalProperties": false
},
"unread": {
"type": "boolean",
"description": "true = only unread entries, false = only read entries."
},
"collection": {
"type": "array",
"items": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1
},
{
"type": "string",
"maxLength": 100,
"minLength": 1
}
],
"description": "A collection id or its exact name."
},
"maxItems": 20,
"minItems": 1
},
"classification": {
"type": "object",
"required": [
"decision"
],
"properties": {
"decision": {
"anyOf": [
{
"type": "string",
"const": "include"
},
{
"type": "string",
"const": "exclude"
}
]
},
"assessment": {
"anyOf": [
{
"type": "string",
"const": "relevant"
},
{
"type": "string",
"const": "irrelevant"
},
{
"type": "string",
"const": "uncertain"
}
]
}
},
"description": "The Collection filter's binary delivery decision and optional underlying assessment. Requires exactly one Collection.",
"additionalProperties": false
},
"published_after": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "When the source published the entry (entries with no publish date are excluded; use top-level since to include them). Relative window (\"7d\", \"36h\", \"45m\", \"2w\"), \"now\", or ISO date."
},
"discovered_after": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "When smry first saw the entry. Backfill makes old posts look new here, so use it for diffs, not for \"what's new\". Relative window (\"7d\", \"36h\", \"45m\", \"2w\"), \"now\", or ISO date."
},
"published_before": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Relative window (\"7d\", \"36h\", \"45m\", \"2w\"), \"now\", or ISO date."
},
"discovered_before": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Relative window (\"7d\", \"36h\", \"45m\", \"2w\"), \"now\", or ISO date."
}
},
"description": "Entry selection predicate: fields AND together; omit a field to not filter on it. Source queries/mutations accept only collection and source; use query having for source-health filters.",
"additionalProperties": false
},
"dry_run": {
"type": "boolean",
"description": "Default true: preview affected records and return a commit_token. Explicit false applies immediately; prefer preview then commit_token for agent workflows."
},
"commit_token": {
"type": "string",
"maxLength": 100,
"description": "From a dry run. Single-use and idempotent: resending after a network failure replays the recorded outcome."
}
},
"additionalProperties": false
}| Only a next_cursor from a previous response; omit on the first call. |
| fields | array | Project only these entry fields. ["id"] is the cheap diff shape. Summary is opt-in. |
| format | any | "compact" returns token-lean text lines (#entry_id [source · s<source_id> · collection] date title / url) in `text`; entries is then an empty array and fields is ignored. |
| having | object | Filter groups/sources on derived values. |
| select | any | "entries" = rows · "sources" = per-source health (where.collection/source only; use having for health filters; stalled = nothing published in 14 days and nothing delivered in 7, quiet = nothing delivered in 7) · "aggregate" = counts. Default "entries". |
| compare | object | Trend detection for aggregates: counts inside the window vs the prior baseline, e.g. {"window":"7d","baseline":"28d"}. |
| group_by | any |
| order_by | any | Default -discovered_at: newest arrivals first, so backfilled items never hide. |
| per_source_limit | integer | Fair sample: at most this many entries per source across the result set, before pagination. Omit for an exhaustive stream. omitted.by_per_source_limit reports articles outside this sample. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Default 20, maximum 100; page further with next_cursor."
},
"since": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The \"what's new\" shorthand: entries published after this time (falling back to discovery time when the feed gives none), newest published first. {\"since\":\"1d\"} is the whole catch-up call. Entries only."
},
"where": {
"type": "object",
"properties": {
"match": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Case-insensitive text match over title and summary. \"a OR b\" matches either."
},
"source": {
"type": "object",
"properties": {
"exclude": {
"type": "array",
"items": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1
},
{
"type": "string",
"maxLength": 500,
"minLength": 1
}
],
"description": "A source id (from any v2 response) or its title. Reads also accept a fragment that matches exactly one title."
},
"maxItems": 100,
"minItems": 1
},
"include": {
"type": "array",
"items": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1
},
{
"type": "string",
"maxLength": 500,
"minLength": 1
}
],
"description": "A source id (from any v2 response) or its title. Reads also accept a fragment that matches exactly one title."
},
"maxItems": 100,
"minItems": 1
}
},
"additionalProperties": false
},
"unread": {
"type": "boolean",
"description": "true = only unread entries, false = only read entries."
},
"collection": {
"type": "array",
"items": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1
},
{
"type": "string",
"maxLength": 100,
"minLength": 1
}
],
"description": "A collection id or its exact name."
},
"maxItems": 20,
"minItems": 1
},
"classification": {
"type": "object",
"required": [
"decision"
],
"properties": {
"decision": {
"anyOf": [
{
"type": "string",
"const": "include"
},
{
"type": "string",
"const": "exclude"
}
]
},
"assessment": {
"anyOf": [
{
"type": "string",
"const": "relevant"
},
{
"type": "string",
"const": "irrelevant"
},
{
"type": "string",
"const": "uncertain"
}
]
}
},
"description": "The Collection filter's binary delivery decision and optional underlying assessment. Requires exactly one Collection.",
"additionalProperties": false
},
"published_after": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "When the source published the entry (entries with no publish date are excluded; use top-level since to include them). Relative window (\"7d\", \"36h\", \"45m\", \"2w\"), \"now\", or ISO date."
},
"discovered_after": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "When smry first saw the entry. Backfill makes old posts look new here, so use it for diffs, not for \"what's new\". Relative window (\"7d\", \"36h\", \"45m\", \"2w\"), \"now\", or ISO date."
},
"published_before": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Relative window (\"7d\", \"36h\", \"45m\", \"2w\"), \"now\", or ISO date."
},
"discovered_before": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Relative window (\"7d\", \"36h\", \"45m\", \"2w\"), \"now\", or ISO date."
}
},
"description": "Entry selection predicate: fields AND together; omit a field to not filter on it. Source queries/mutations accept only collection and source; use query having for source-health filters.",
"additionalProperties": false
},
"cursor": {
"type": "string",
"maxLength": 500,
"description": "Only a next_cursor from a previous response; omit on the first call."
},
"fields": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"const": "id"
},
{
"type": "string",
"const": "source"
},
{
"type": "string",
"const": "source_id"
},
{
"type": "string",
"const": "collection"
},
{
"type": "string",
"const": "title"
},
{
"type": "string",
"const": "url"
},
{
"type": "string",
"const": "summary"
},
{
"type": "string",
"const": "author"
},
{
"type": "string",
"const": "image_url"
},
{
"type": "string",
"const": "published_at"
},
{
"type": "string",
"const": "discovered_at"
},
{
"type": "string",
"const": "unread"
},
{
"type": "string",
"const": "classification"
},
{
"type": "string",
"const": "feedback"
}
]
},
"maxItems": 14,
"description": "Project only these entry fields. [\"id\"] is the cheap diff shape. Summary is opt-in."
},
"format": {
"anyOf": [
{
"type": "string",
"const": "json"
},
{
"type": "string",
"const": "compact"
}
],
"description": "\"compact\" returns token-lean text lines (#entry_id [source · s<source_id> · collection] date title / url) in `text`; entries is then an empty array and fields is ignored."
},
"having": {
"type": "object",
"properties": {
"count": {
"type": "object",
"properties": {
"gte": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"lte": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": {}
},
"unread": {
"type": "object",
"properties": {
"gte": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"lte": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": {}
},
"silent_days": {
"type": "object",
"properties": {
"gte": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"lte": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"additionalProperties": {}
}
},
"description": "Filter groups/sources on derived values.",
"additionalProperties": {}
},
"select": {
"anyOf": [
{
"type": "string",
"const": "entries"
},
{
"type": "string",
"const": "sources"
},
{
"type": "string",
"const": "aggregate"
}
],
"description": "\"entries\" = rows · \"sources\" = per-source health (where.collection/source only; use having for health filters; stalled = nothing published in 14 days and nothing delivered in 7, quiet = nothing delivered in 7) · \"aggregate\" = counts. Default \"entries\"."
},
"compare": {
"type": "object",
"required": [
"window",
"baseline"
],
"properties": {
"window": {
"type": "string",
"maxLength": 64
},
"baseline": {
"type": "string",
"maxLength": 64
}
},
"description": "Trend detection for aggregates: counts inside the window vs the prior baseline, e.g. {\"window\":\"7d\",\"baseline\":\"28d\"}.",
"additionalProperties": {}
},
"group_by": {
"anyOf": [
{
"type": "string",
"const": "source"
},
{
"type": "string",
"const": "collection"
},
{
"type": "string",
"const": "day"
}
]
},
"order_by": {
"anyOf": [
{
"type": "string",
"const": "-discovered_at"
},
{
"type": "string",
"const": "discovered_at"
},
{
"type": "string",
"const": "-published_at"
},
{
"type": "string",
"const": "published_at"
}
],
"description": "Default -discovered_at: newest arrivals first, so backfilled items never hide."
},
"per_source_limit": {
"type": "integer",
"maximum": 20,
"minimum": 1,
"description": "Fair sample: at most this many entries per source across the result set, before pagination. Omit for an exhaustive stream. omitted.by_per_source_limit reports articles outside this sample."
}
},
"additionalProperties": false
}| content_kind | any |
| published_at | any |
| capture_method | any |
{
"type": "object",
"required": [
"title",
"content"
],
"properties": {
"url": {
"type": "string",
"format": "uri",
"maxLength": 4096
},
"tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 32
},
"maxItems": 12
},
"title": {
"type": "string",
"maxLength": 500,
"minLength": 1
},
"author": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "null"
}
]
},
"format": {
"anyOf": [
{
"type": "string",
"const": "html"
},
{
"type": "string",
"const": "pdf"
},
{
"type": "string",
"const": "epub"
},
{
"type": "string",
"const": "markdown"
},
{
"type": "string",
"const": "plain_text"
},
{
"type": "string",
"const": "document"
},
{
"type": "string",
"const": "spreadsheet"
},
{
"type": "string",
"const": "presentation"
},
{
"type": "string",
"const": "audio"
},
{
"type": "string",
"const": "video"
},
{
"type": "string",
"const": "unknown"
}
]
},
"status": {
"anyOf": [
{
"type": "string",
"const": "inbox"
},
{
"type": "string",
"const": "later"
},
{
"type": "string",
"const": "archive"
}
]
},
"content": {
"type": "string",
"maxLength": 2000000,
"minLength": 1
},
"starred": {
"type": "boolean"
},
"metadata": {
"type": "object",
"patternProperties": {
"^(.*)$": {}
}
},
"file_name": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "null"
}
]
},
"mime_type": {
"anyOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "null"
}
]
},
"external_id": {
"anyOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "null"
}
]
},
"content_kind": {
"anyOf": [
{
"type": "string",
"const": "article"
},
{
"type": "string",
"const": "website"
},
{
"type": "string",
"const": "book"
},
{
"type": "string",
"const": "email"
},
{
"type": "string",
"const": "pdf"
},
{
"type": "string",
"const": "social_post"
},
{
"type": "string",
"const": "video"
},
{
"type": "string",
"const": "podcast_episode"
},
{
"type": "string",
"const": "document"
},
{
"type": "string",
"const": "unknown"
}
]
},
"published_at": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
]
},
"capture_method": {
"anyOf": [
{
"type": "string",
"const": "reader"
},
{
"type": "string",
"const": "extension"
},
{
"type": "string",
"const": "upload"
},
{
"type": "string",
"const": "rss"
},
{
"type": "string",
"const": "email_inbox"
},
{
"type": "string",
"const": "api"
},
{
"type": "string",
"const": "import"
}
]
}
},
"additionalProperties": false
}