Referencia de la API

Feeds (RSS)

Suscríbete a feeds RSS/Atom, obtén entradas y guarda artículos como notas. Admite importación/exportación OPML.

Definiciones de tipos

bash
type Feed {
  id: ID!
  url: String!                # RSS/Atom URL
  name: String!               # display name (defaults to feed title)
  fetchContent: Boolean!      # when true, the server fetches the full article body
  updatedAt: String!
}

type FeedCount {
  feedId: ID!
  count: Int!                 # total entries
  unreadCount: Int!
}

type FeedEntry {
  id: ID!
  feedId: ID!
  title: String!
  description: String!        # short summary
  content: String!            # full article body (may be empty until fetched)
  url: String!                # canonical article URL
  publishedAt: String!        # ISO 8601
  read: Boolean!
  favorite: Boolean!
  tags: [Tag!]!
}

Operaciones

query

feeds

Lista todos los feeds suscritos.

bash
query GetFeeds {
  feeds { id url name fetchContent updatedAt }
}
query

feedsCount

Contadores de entradas totales y no leídas por feed.

bash
query GetFeedsCount {
  feedsCount { feedId count unreadCount }
}
query

feedEntries

Busca entradas de feed (título + descripción). Deja la consulta vacía para listar todas.

bash
query GetFeedEntries($offset: Int!, $limit: Int!, $query: String!) {
  feedEntries(offset: $offset, limit: $limit, query: $query) {
    id feedId title description content url publishedAt read favorite
    tags { id name }
  }
}
query

feedEntryCount

Cuenta las entradas de feed que coinciden con una consulta.

bash
query GetFeedEntryCount($query: String!) {
  feedEntryCount(query: $query)
}
query

feedEntry

Obtiene una única entrada de feed por ID.

bash
query GetFeedEntry($id: ID!) {
  feedEntry(id: $id) { id feedId title description content url publishedAt read favorite }
}
mutation

createFeed

Suscribe a un feed nuevo. El servidor obtiene el canal RSS para rellenar el nombre y luego lanza una sincronización única.

bash
mutation CreateFeed($url: String!, $fetchContent: Boolean!) {
  createFeed(url: $url, fetchContent: $fetchContent) { id url name fetchContent updatedAt }
}
mutation

updateFeed

Actualiza el nombre para mostrar o el indicador fetchContent de un feed.

bash
mutation UpdateFeed($id: ID!, $name: String!, $fetchContent: Boolean!) {
  updateFeed(id: $id, name: $name, fetchContent: $fetchContent) { id url name fetchContent updatedAt }
}
mutation

deleteFeed

Se desuscribe de un feed y elimina todas sus entradas (y sus relaciones de etiquetas).

bash
mutation DeleteFeed($id: ID!) {
  deleteFeed(id: $id)
}
mutation

syncFeeds

Dispara un worker de sincronización de feeds única. Pasa un id para sincronizar un único feed; pasa null o vacío para sincronizar todos.

bash
mutation SyncFeeds($id: ID) {
  syncFeeds(id: $id)
}
mutation

fetchFeedContent

Obtiene el cuerpo completo del artículo para una única entrada de feed. Devuelve la entrada actualizada.

bash
mutation FetchFeedContent($id: ID!) {
  fetchFeedContent(id: $id) { id content }
}
mutation

syncFeedContent

Alias de fetchFeedContent. Mantenido por compatibilidad retroactiva.

bash
mutation SyncFeedContent($id: ID!) {
  syncFeedContent(id: $id) { id content }
}
mutation

deleteFeedEntries

Elimina las entradas de feed que coinciden con una consulta (y sus relaciones de etiquetas).

bash
mutation DeleteFeedEntries($query: String!) {
  deleteFeedEntries(query: $query)
}
mutation

importFeeds

Importa un documento OPML (como cadena) en la base de datos de feeds.

bash
mutation ImportFeeds($content: String!) {
  importFeeds(content: $content)
}
mutation

exportFeeds

Exporta todos los feeds suscritos como cadena OPML.

bash
mutation ExportFeeds {
  exportFeeds
}