{
    "info": {
        "name": "FeedBro API",
        "description": "Your FeedBro feeds and articles as JSON. Set the collection variable apiKey to a personal key from Settings, API tab, then send any request.\nDocs: https://feedbro.com/developers",
        "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
    },
    "auth": {
        "type": "bearer",
        "bearer": [
            {
                "key": "token",
                "value": "{{apiKey}}",
                "type": "string"
            }
        ]
    },
    "variable": [
        {
            "key": "baseUrl",
            "value": "https://feedbro.com/api/v1"
        },
        {
            "key": "apiKey",
            "value": ""
        }
    ],
    "item": [
        {
            "name": "Reading",
            "item": [
                {
                    "name": "GET /account: Your plan and reading preferences",
                    "request": {
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application/json"
                            }
                        ],
                        "url": {
                            "raw": "{{baseUrl}}/account",
                            "host": [
                                "{{baseUrl}}"
                            ],
                            "path": [
                                "account"
                            ]
                        },
                        "description": "Your plan and reading preferences. Counts as 1 request."
                    }
                },
                {
                    "name": "GET /feeds: Your feeds",
                    "request": {
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application/json"
                            }
                        ],
                        "url": {
                            "raw": "{{baseUrl}}/feeds?since_hours=24",
                            "host": [
                                "{{baseUrl}}"
                            ],
                            "path": [
                                "feeds"
                            ],
                            "query": [
                                {
                                    "key": "since_hours",
                                    "value": "24",
                                    "description": "Count unread only from the last so many hours",
                                    "disabled": false
                                }
                            ]
                        },
                        "description": "Your feeds. Counts as 1 request."
                    }
                },
                {
                    "name": "GET /articles: Your articles, newest first",
                    "request": {
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application/json"
                            }
                        ],
                        "url": {
                            "raw": "{{baseUrl}}/articles?filter=unread",
                            "host": [
                                "{{baseUrl}}"
                            ],
                            "path": [
                                "articles"
                            ],
                            "query": [
                                {
                                    "key": "filter",
                                    "value": "unread",
                                    "description": "all, unread, saved or read_later",
                                    "disabled": false
                                },
                                {
                                    "key": "feed_id",
                                    "value": "",
                                    "description": "Only this feed (an id from /feeds)",
                                    "disabled": true
                                },
                                {
                                    "key": "collection_id",
                                    "value": "",
                                    "description": "Only this collection (an id from /collections)",
                                    "disabled": true
                                },
                                {
                                    "key": "since_hours",
                                    "value": "",
                                    "description": "Only articles from the last so many hours",
                                    "disabled": true
                                },
                                {
                                    "key": "cursor",
                                    "value": "",
                                    "description": "next_cursor from the previous page",
                                    "disabled": true
                                }
                            ]
                        },
                        "description": "Your articles, newest first. Counts as 1 request."
                    }
                },
                {
                    "name": "GET /articles/{article}: One article with its full text",
                    "request": {
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application/json"
                            }
                        ],
                        "url": {
                            "raw": "{{baseUrl}}/articles/:article",
                            "host": [
                                "{{baseUrl}}"
                            ],
                            "path": [
                                "articles",
                                ":article"
                            ],
                            "variable": [
                                {
                                    "key": "article",
                                    "value": "",
                                    "description": "An article id from /articles"
                                }
                            ]
                        },
                        "description": "One article with its full text. Counts as 1 request."
                    }
                },
                {
                    "name": "GET /collections: Your collections and their feeds",
                    "request": {
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application/json"
                            }
                        ],
                        "url": {
                            "raw": "{{baseUrl}}/collections",
                            "host": [
                                "{{baseUrl}}"
                            ],
                            "path": [
                                "collections"
                            ]
                        },
                        "description": "Your collections and their feeds. Counts as 1 request."
                    }
                },
                {
                    "name": "GET /saved-pages: Pages saved from the browser extension",
                    "request": {
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application/json"
                            }
                        ],
                        "url": {
                            "raw": "{{baseUrl}}/saved-pages",
                            "host": [
                                "{{baseUrl}}"
                            ],
                            "path": [
                                "saved-pages"
                            ]
                        },
                        "description": "Pages saved from the browser extension. Counts as 1 request."
                    }
                },
                {
                    "name": "GET /summary/unread-count: Unread count across your feeds",
                    "request": {
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application/json"
                            }
                        ],
                        "url": {
                            "raw": "{{baseUrl}}/summary/unread-count",
                            "host": [
                                "{{baseUrl}}"
                            ],
                            "path": [
                                "summary",
                                "unread-count"
                            ]
                        },
                        "description": "Unread count across your feeds. Counts as 1 request."
                    }
                }
            ]
        },
        {
            "name": "Marking articles",
            "item": [
                {
                    "name": "POST /articles/{article}/read: Read / unread (switches)",
                    "request": {
                        "method": "POST",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application/json"
                            }
                        ],
                        "url": {
                            "raw": "{{baseUrl}}/articles/:article/read",
                            "host": [
                                "{{baseUrl}}"
                            ],
                            "path": [
                                "articles",
                                ":article",
                                "read"
                            ],
                            "variable": [
                                {
                                    "key": "article",
                                    "value": "",
                                    "description": "An article id from /articles"
                                }
                            ]
                        },
                        "description": "Read / unread (switches) (Coffee Club). Counts as 1 request."
                    }
                },
                {
                    "name": "POST /articles/{article}/save: Saved / not saved (switches)",
                    "request": {
                        "method": "POST",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application/json"
                            }
                        ],
                        "url": {
                            "raw": "{{baseUrl}}/articles/:article/save",
                            "host": [
                                "{{baseUrl}}"
                            ],
                            "path": [
                                "articles",
                                ":article",
                                "save"
                            ],
                            "variable": [
                                {
                                    "key": "article",
                                    "value": "",
                                    "description": "An article id from /articles"
                                }
                            ]
                        },
                        "description": "Saved / not saved (switches) (Coffee Club). Counts as 1 request."
                    }
                },
                {
                    "name": "POST /articles/{article}/read-later: Read later / not (switches)",
                    "request": {
                        "method": "POST",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application/json"
                            }
                        ],
                        "url": {
                            "raw": "{{baseUrl}}/articles/:article/read-later",
                            "host": [
                                "{{baseUrl}}"
                            ],
                            "path": [
                                "articles",
                                ":article",
                                "read-later"
                            ],
                            "variable": [
                                {
                                    "key": "article",
                                    "value": "",
                                    "description": "An article id from /articles"
                                }
                            ]
                        },
                        "description": "Read later / not (switches) (Coffee Club). Counts as 1 request."
                    }
                }
            ]
        },
        {
            "name": "Background jobs",
            "item": [
                {
                    "name": "POST /articles/{article}/fetch: Fetch an article's full text",
                    "request": {
                        "method": "POST",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application/json"
                            }
                        ],
                        "url": {
                            "raw": "{{baseUrl}}/articles/:article/fetch",
                            "host": [
                                "{{baseUrl}}"
                            ],
                            "path": [
                                "articles",
                                ":article",
                                "fetch"
                            ],
                            "variable": [
                                {
                                    "key": "article",
                                    "value": "",
                                    "description": "An article id from /articles"
                                }
                            ]
                        },
                        "description": "Fetch an article's full text (Coffee Club). Counts as 10 requests."
                    }
                },
                {
                    "name": "POST /extract: The main content of any web page",
                    "request": {
                        "method": "POST",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application/json"
                            },
                            {
                                "key": "Content-Type",
                                "value": "application/json"
                            }
                        ],
                        "url": {
                            "raw": "{{baseUrl}}/extract",
                            "host": [
                                "{{baseUrl}}"
                            ],
                            "path": [
                                "extract"
                            ]
                        },
                        "description": "The main content of any web page (Coffee Club). Counts as 10 requests.",
                        "body": {
                            "mode": "raw",
                            "raw": "{\n    \"url\": \"https://www.example.com/some-article\",\n    \"main_only\": true\n}",
                            "options": {
                                "raw": {
                                    "language": "json"
                                }
                            }
                        }
                    }
                },
                {
                    "name": "POST /feeds/add: Follow a feed or a website",
                    "request": {
                        "method": "POST",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application/json"
                            },
                            {
                                "key": "Content-Type",
                                "value": "application/json"
                            }
                        ],
                        "url": {
                            "raw": "{{baseUrl}}/feeds/add",
                            "host": [
                                "{{baseUrl}}"
                            ],
                            "path": [
                                "feeds",
                                "add"
                            ]
                        },
                        "description": "Follow a feed or a website (Coffee Club). Counts as 5 requests.",
                        "body": {
                            "mode": "raw",
                            "raw": "{\n    \"url\": \"https://www.example.com/feed/\"\n}",
                            "options": {
                                "raw": {
                                    "language": "json"
                                }
                            }
                        }
                    }
                },
                {
                    "name": "GET /jobs/{id}: A job's status and result",
                    "request": {
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application/json"
                            }
                        ],
                        "url": {
                            "raw": "{{baseUrl}}/jobs/:id",
                            "host": [
                                "{{baseUrl}}"
                            ],
                            "path": [
                                "jobs",
                                ":id"
                            ],
                            "variable": [
                                {
                                    "key": "id",
                                    "value": "",
                                    "description": "The job id a job call answered with"
                                }
                            ]
                        },
                        "description": "A job's status and result. Counts as 1 request."
                    }
                }
            ]
        },
        {
            "name": "Webhooks",
            "item": [
                {
                    "name": "GET /webhook: The current address and events",
                    "request": {
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application/json"
                            }
                        ],
                        "url": {
                            "raw": "{{baseUrl}}/webhook",
                            "host": [
                                "{{baseUrl}}"
                            ],
                            "path": [
                                "webhook"
                            ]
                        },
                        "description": "The current address and events. Counts as 1 request."
                    }
                },
                {
                    "name": "POST /webhook: Set the address (shows the signing secret once)",
                    "request": {
                        "method": "POST",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application/json"
                            },
                            {
                                "key": "Content-Type",
                                "value": "application/json"
                            }
                        ],
                        "url": {
                            "raw": "{{baseUrl}}/webhook",
                            "host": [
                                "{{baseUrl}}"
                            ],
                            "path": [
                                "webhook"
                            ]
                        },
                        "description": "Set the address (shows the signing secret once) (Coffee Club). Counts as 1 request.",
                        "body": {
                            "mode": "raw",
                            "raw": "{\n    \"url\": \"https://your-server.example/feedbro-hook\"\n}",
                            "options": {
                                "raw": {
                                    "language": "json"
                                }
                            }
                        }
                    }
                },
                {
                    "name": "POST /webhook/test: Send a ping event now",
                    "request": {
                        "method": "POST",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application/json"
                            }
                        ],
                        "url": {
                            "raw": "{{baseUrl}}/webhook/test",
                            "host": [
                                "{{baseUrl}}"
                            ],
                            "path": [
                                "webhook",
                                "test"
                            ]
                        },
                        "description": "Send a ping event now (Coffee Club). Counts as 1 request."
                    }
                },
                {
                    "name": "POST /webhook/remove: Stop sending",
                    "request": {
                        "method": "POST",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application/json"
                            }
                        ],
                        "url": {
                            "raw": "{{baseUrl}}/webhook/remove",
                            "host": [
                                "{{baseUrl}}"
                            ],
                            "path": [
                                "webhook",
                                "remove"
                            ]
                        },
                        "description": "Stop sending (Coffee Club). Counts as 1 request."
                    }
                }
            ]
        },
        {
            "name": "Website Watch (beta)",
            "item": [
                {
                    "name": "GET /watches: Your watched pages and stores",
                    "request": {
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application/json"
                            }
                        ],
                        "url": {
                            "raw": "{{baseUrl}}/watches",
                            "host": [
                                "{{baseUrl}}"
                            ],
                            "path": [
                                "watches"
                            ]
                        },
                        "description": "Your watched pages and stores. Counts as 1 request."
                    }
                },
                {
                    "name": "GET /watches/{feed}/items: A watch's items, newest first",
                    "request": {
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application/json"
                            }
                        ],
                        "url": {
                            "raw": "{{baseUrl}}/watches/:feed/items?",
                            "host": [
                                "{{baseUrl}}"
                            ],
                            "path": [
                                "watches",
                                ":feed",
                                "items"
                            ],
                            "query": [
                                {
                                    "key": "cursor",
                                    "value": "",
                                    "description": "next_cursor from the previous page",
                                    "disabled": true
                                }
                            ],
                            "variable": [
                                {
                                    "key": "feed",
                                    "value": "",
                                    "description": "A watch id from /watches"
                                }
                            ]
                        },
                        "description": "A watch's items, newest first. Counts as 1 request."
                    }
                },
                {
                    "name": "POST /watches: Start watching a page",
                    "request": {
                        "method": "POST",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application/json"
                            },
                            {
                                "key": "Content-Type",
                                "value": "application/json"
                            }
                        ],
                        "url": {
                            "raw": "{{baseUrl}}/watches",
                            "host": [
                                "{{baseUrl}}"
                            ],
                            "path": [
                                "watches"
                            ]
                        },
                        "description": "Start watching a page (Coffee Club). Counts as 25 requests.",
                        "body": {
                            "mode": "raw",
                            "raw": "{\n    \"url\": \"https://www.example.com/news\",\n    \"page_anyway\": \"\"\n}",
                            "options": {
                                "raw": {
                                    "language": "json"
                                }
                            }
                        }
                    }
                }
            ]
        }
    ]
}