{"openapi":"3.1.0","info":{"title":"RedditDate Data API","description":"\nRedditDate Data API 面向需要读取 Reddit 社区帖子、评论、历史归档和导出任务的客户。\n\n认证方式：在请求头加入 `X-API-Key: sk_live_xxx`。客户控制台登录、邮箱验证、密码重置和管理员运营接口不在本公开文档中展示。\n\n常见错误：`401` 表示 API Key 无效，`402` 表示额度不足，`403` 表示套餐过期或账号不可用，`404` 表示资源不存在，`422` 表示参数不合法，`429` 表示请求过快。\n","version":"0.1.0"},"paths":{"/health":{"get":{"summary":"服务健康检查","operationId":"health_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{},"example":{"status":"ok","service":"community-data-api","version":"0.1.0"}}}}},"tags":["系统状态"],"description":"用于确认 API 服务是否在线，不需要认证。"}},"/v1/account/usage":{"get":{"summary":"查看账号额度","operationId":"usage_v1_account_usage_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{},"example":{"plan":"standard_30d","remaining_records":18420,"monthly_quota":20000,"bulk_history_remaining":1000000,"assistant_remaining":100}}}}},"security":[{"APIKeyHeader":[]}],"tags":["账号与额度"],"description":"返回当前 API Key 对应客户的普通数据、大额历史和附加功能额度。各业务按剩余额度使用，不再按账号到期时间拦截。\n\n认证：请求头 `X-API-Key: sk_live_xxx`。"}},"/v1/subreddits/{subreddit}/posts":{"get":{"summary":"读取社区最新帖子","operationId":"posts_v1_subreddits__subreddit__posts_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"subreddit","in":"path","required":true,"schema":{"type":"string","title":"Subreddit"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Limit"}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","default":"new","title":"Sort"}},{"name":"t","in":"query","required":false,"schema":{"type":"string","default":"all","title":"T"}},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"After"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{},"example":{"success":true,"data":{"items":[{"id":"abc123","subreddit":"Bitcoin","title":"Example post","author":"reddit_user","score":128,"comment_count":34,"published_at":"2026-07-05T12:00:00Z","reddit_url":"https://www.reddit.com/r/Bitcoin/comments/abc123/example/"}],"pagination":{"next_cursor":1783252800,"limit":25}},"meta":{"cached":false,"source":"reddit_archive"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["实时数据"],"description":"按发布时间倒序读取社区最新归档帖子，当前仅支持 sort=new。after 使用上一页返回的时间游标。归档可能有短暂延迟，返回记录会计入普通数据额度。\n\n认证：请求头 `X-API-Key: sk_live_xxx`。"}},"/v1/posts/{post_id}/comments":{"get":{"summary":"读取帖子评论","operationId":"comments_v1_posts__post_id__comments_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"post_id","in":"path","required":true,"schema":{"type":"string","title":"Post Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":0,"default":10,"title":"Limit"}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","default":"confidence","title":"Sort"}},{"name":"max_depth","in":"query","required":false,"schema":{"type":"integer","maximum":5,"minimum":0,"default":3,"title":"Max Depth"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{},"example":{"success":true,"data":{"post_id":"abc123","comments":[{"id":"c1","author":"reddit_user","body":"Example comment","score":12,"depth":0}],"count":1,"unexpanded_hint":0},"meta":{"cached":true,"source":"reddit_archive","sort":"thread"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["实时数据"],"description":"从归档评论树读取单个帖子下的评论。sort 参数为兼容保留，结果按评论树顺序返回；归档可能有短暂延迟。返回评论数量会计入普通数据额度。\n\n认证：请求头 `X-API-Key: sk_live_xxx`。"}},"/v1/users/{username}/posts":{"get":{"summary":"读取用户发布的帖子","operationId":"user_posts_v1_users__username__posts_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"username","in":"path","required":true,"schema":{"type":"string","title":"Username"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Limit"}},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"After"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{},"example":{"success":true,"data":{"username":"reddit_user","items":[{"id":"abc123","subreddit":"Bitcoin","title":"Example post","author":"reddit_user","content":"Post body","score":12,"comment_count":3,"published_at":"2026-07-05T12:00:00Z","reddit_url":"https://www.reddit.com/r/Bitcoin/comments/abc123/example/"}],"count":1,"pagination":{"next_cursor":1783252800,"limit":25}},"meta":{"cached":false,"fetched_at":"2026-07-05T12:01:00Z"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["用户数据"],"description":"按 Reddit 用户名读取该用户公开发布的帖子，按发布时间倒序返回。after 使用上一页返回的 next_cursor；结果可能有短暂延迟，返回记录会计入普通数据额度。\n\n认证：请求头 `X-API-Key: sk_live_xxx`。"}},"/v1/users/{username}/comments":{"get":{"summary":"读取用户发布的评论","operationId":"user_comments_v1_users__username__comments_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"username","in":"path","required":true,"schema":{"type":"string","title":"Username"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Limit"}},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"After"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{},"example":{"success":true,"data":{"username":"reddit_user","items":[{"id":"comment1","post_id":"abc123","subreddit":"Bitcoin","parent_id":"t3_abc123","author":"reddit_user","body":"Example comment","score":4,"published_at":"2026-07-05T12:00:00Z","reddit_url":"https://www.reddit.com/r/Bitcoin/comments/abc123/example/comment1/"}],"count":1,"pagination":{"next_cursor":1783252800,"limit":25}},"meta":{"cached":false,"fetched_at":"2026-07-05T12:01:00Z"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["用户数据"],"description":"按 Reddit 用户名读取该用户公开发布的评论，按发布时间倒序返回。after 使用上一页返回的 next_cursor；结果可能有短暂延迟，返回记录会计入普通数据额度。\n\n认证：请求头 `X-API-Key: sk_live_xxx`。"}},"/v1/bulk-history/posts":{"get":{"summary":"读取历史帖子分页","operationId":"bulk_history_posts_v1_bulk_history_posts_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"subreddit","in":"query","required":true,"schema":{"type":"string","title":"Subreddit"}},{"name":"date_from","in":"query","required":true,"schema":{"type":"string","format":"date","title":"Date From"}},{"name":"date_to","in":"query","required":true,"schema":{"type":"string","format":"date","title":"Date To"}},{"name":"after_cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"After Cursor"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":100,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{},"example":{"success":true,"data":{"items":[{"id":"abc123","subreddit":"Bitcoin","title":"Historical post","score":320,"published_at":"2021-03-25T10:00:00Z"}],"count":1,"pagination":{"next_cursor":1616670001,"limit":100}},"meta":{"source":"historical_archive","charged_records":1}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["大额历史"],"description":"从历史归档读取指定社区和日期范围内的帖子。适合程序分页拉取，返回记录计入大额历史额度。\n\n认证：请求头 `X-API-Key: sk_live_xxx`。"}},"/v1/bulk-history/comments":{"get":{"summary":"读取历史评论分页","operationId":"bulk_history_comments_v1_bulk_history_comments_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"subreddit","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subreddit"}},{"name":"post_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Post Id"}},{"name":"date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date From"}},{"name":"date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date To"}},{"name":"after_cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"After Cursor"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":100,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{},"example":{"success":true,"data":{"items":[{"id":"comment1","post_id":"abc123","subreddit":"Bitcoin","author":"reddit_user","body":"Historical comment","score":8,"published_at":"2021-03-25T11:00:00Z"}],"count":1,"pagination":{"next_cursor":1616673601,"limit":100}},"meta":{"source":"historical_archive","charged_records":1}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["大额历史"],"description":"按社区或 post_id 从历史归档读取评论。返回记录计入大额历史额度。\n\n认证：请求头 `X-API-Key: sk_live_xxx`。"}},"/v1/bulk-history/users/{username}/posts":{"get":{"summary":"按用户读取历史帖子","operationId":"bulk_history_user_posts_v1_bulk_history_users__username__posts_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"username","in":"path","required":true,"schema":{"type":"string","title":"Username"}},{"name":"date_from","in":"query","required":true,"schema":{"type":"string","format":"date","title":"Date From"}},{"name":"date_to","in":"query","required":true,"schema":{"type":"string","format":"date","title":"Date To"}},{"name":"after_cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"After Cursor"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":100,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{},"example":{"success":true,"data":{"username":"reddit_user","items":[{"id":"abc123","subreddit":"Bitcoin","title":"Historical post","author":"reddit_user","published_at":"2021-03-25T10:00:00Z"}],"count":1,"pagination":{"next_cursor":1616666401,"limit":100,"requested_limit":100}},"meta":{"source":"historical_archive","charged_records":1,"bulk_history_remaining":999999}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["大额历史"],"description":"按 Reddit 用户名和 UTC 日期范围读取该用户公开发布的历史帖子。使用 next_cursor 作为 after_cursor 继续分页；返回记录计入大额历史额度。\n\n认证：请求头 `X-API-Key: sk_live_xxx`。"}},"/v1/bulk-history/users/{username}/comments":{"get":{"summary":"按用户读取历史评论","operationId":"bulk_history_user_comments_v1_bulk_history_users__username__comments_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"username","in":"path","required":true,"schema":{"type":"string","title":"Username"}},{"name":"date_from","in":"query","required":true,"schema":{"type":"string","format":"date","title":"Date From"}},{"name":"date_to","in":"query","required":true,"schema":{"type":"string","format":"date","title":"Date To"}},{"name":"after_cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"After Cursor"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":100,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{},"example":{"success":true,"data":{"username":"reddit_user","items":[{"id":"comment1","post_id":"abc123","subreddit":"Bitcoin","author":"reddit_user","body":"Historical comment","score":8,"published_at":"2021-03-25T11:00:00Z"}],"count":1,"pagination":{"next_cursor":1616670001,"limit":100,"requested_limit":100}},"meta":{"source":"historical_archive","charged_records":1,"bulk_history_remaining":999999}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["大额历史"],"description":"按 Reddit 用户名和 UTC 日期范围读取该用户公开发布的历史评论。使用 next_cursor 作为 after_cursor 继续分页；返回记录计入大额历史额度。\n\n认证：请求头 `X-API-Key: sk_live_xxx`。"}},"/v1/bulk-history/exports":{"get":{"summary":"列出大额历史导出任务","operationId":"list_bulk_history_exports_v1_bulk_history_exports_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{},"example":[{"id":"job-id","subreddit":"Bitcoin","status":"completed","download_url":"/downloads/bulk-job-id/","posts":1000,"comments":5000}]}}}},"security":[{"APIKeyHeader":[]}],"tags":["大额历史"],"description":"查看当前客户最近创建的大额历史导出任务。\n\n认证：请求头 `X-API-Key: sk_live_xxx`。"},"post":{"summary":"创建大额历史导出任务","operationId":"create_bulk_history_export_v1_bulk_history_exports_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkHistoryExportIn"},"example":{"title":"Bitcoin 2024 comments","subreddit":"Bitcoin","date_from":"2024-01-01","date_to":"2024-12-31","include_posts":true,"include_comments":true,"export_profile":"monthly_raw"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{},"example":{"id":"job-id","subreddit":"Bitcoin","status":"pending","download_url":null,"created_at":"2026-07-05T12:00:00Z"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}],"tags":["大额历史"],"description":"创建后台导出任务。任务完成后会生成下载页面，并在邮件通知开启且邮箱已验证时发送完成通知。\n\n认证：请求头 `X-API-Key: sk_live_xxx`。"}},"/v1/bulk-history/exports/{export_id}":{"get":{"summary":"查看大额历史导出任务","operationId":"get_bulk_history_export_v1_bulk_history_exports__export_id__get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"export_id","in":"path","required":true,"schema":{"type":"string","title":"Export Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{},"example":{"id":"job-id","status":"running","completed_partitions":8,"total_partitions":24,"download_url":null}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["大额历史"],"description":"查看单个导出任务状态、进度和下载地址。\n\n认证：请求头 `X-API-Key: sk_live_xxx`。"},"delete":{"summary":"删除未运行的大额历史任务","operationId":"delete_bulk_history_export_v1_bulk_history_exports__export_id__delete","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"export_id","in":"path","required":true,"schema":{"type":"string","title":"Export Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{},"example":{"deleted":true,"id":"job-id"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["大额历史"],"description":"删除 pending/completed/failed 状态的任务记录；运行中的任务不能删除。\n\n认证：请求头 `X-API-Key: sk_live_xxx`。"}},"/v1/bulk-history/exports/{export_id}/resume":{"post":{"summary":"继续未完成的大额任务","operationId":"resume_bulk_history_export_v1_bulk_history_exports__export_id__resume_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"export_id","in":"path","required":true,"schema":{"type":"string","title":"Export Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{},"example":{"id":"job-id","status":"pending","partial":false,"charged_records":500000,"resume_available":false}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["大额历史"],"description":"将额度中断任务或含失败分片的 monthly_raw 任务重新排队。已完成分片不会重复抓取，仅从未完成分片保存的游标继续。\n\n认证：请求头 `X-API-Key: sk_live_xxx`。"}},"/v1/collectors":{"get":{"summary":"列出采集任务","operationId":"list_collectors_v1_collectors_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{},"example":[{"id":"collector-id","subreddit":"Bitcoin","active":true,"delivered_posts":120,"delivered_comments":340}]}}}},"security":[{"APIKeyHeader":[]}],"tags":["采集任务"],"description":"查看当前客户创建过的定时采集任务及已交付记录数。\n\n认证：请求头 `X-API-Key: sk_live_xxx`。"},"post":{"summary":"创建定时采集任务","operationId":"create_collector_v1_collectors_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectorIn"},"example":{"subreddit":"Bitcoin","interval_minutes":60,"sort":"new","comment_limit":10,"keywords":["ETF","halving"]}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{},"example":{"id":"collector-id","status":"scheduled"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}],"tags":["采集任务"],"description":"定时采集指定社区的新帖子和可选评论。适合持续监控。\n\n认证：请求头 `X-API-Key: sk_live_xxx`。"}},"/v1/collectors/{collector_id}/status":{"put":{"summary":"暂停或恢复采集任务","operationId":"set_collector_status_v1_collectors__collector_id__status_put","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"collector_id","in":"path","required":true,"schema":{"type":"string","title":"Collector Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectorStatusIn"},"example":{"active":true}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{},"example":{"id":"collector-id","status":"active","status_label":"运行中"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["采集任务"],"description":"传入 active=false 手动暂停，传入 active=true 恢复可自行恢复的任务。额度不足或账号状态异常时会返回明确提示。\n\n认证：请求头 `X-API-Key: sk_live_xxx`。"}},"/v1/collectors/{collector_id}":{"delete":{"summary":"暂停采集任务","operationId":"stop_collector_v1_collectors__collector_id__delete","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"collector_id","in":"path","required":true,"schema":{"type":"string","title":"Collector Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{},"example":{"stopped":true,"status":"user_paused"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["采集任务"],"description":"兼容接口：手动暂停一个定时采集任务，不删除已经采集的数据。\n\n认证：请求头 `X-API-Key: sk_live_xxx`。"}},"/v1/keyword-matches":{"get":{"summary":"查看关键词命中","operationId":"keyword_matches_v1_keyword_matches_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{},"example":[{"post_id":"abc123","keyword":"ETF","matched_field":"title","detected_at":"2026-07-05T12:00:00Z"}]}}}},"security":[{"APIKeyHeader":[]}],"tags":["采集任务"],"description":"返回定时采集任务中命中的关键词记录。\n\n认证：请求头 `X-API-Key: sk_live_xxx`。"}},"/v1/backfills":{"get":{"summary":"列出历史回溯任务","operationId":"list_backfills_v1_backfills_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{},"example":[{"id":"backfill-id","subreddit":"Bitcoin","status":"completed","collected_posts":500,"collected_comments":3500}]}}}},"security":[{"APIKeyHeader":[]}],"tags":["历史回溯"],"description":"查看小范围历史回溯任务状态和已采集数量。\n\n认证：请求头 `X-API-Key: sk_live_xxx`。"},"post":{"summary":"创建小范围历史回溯","operationId":"create_backfill_v1_backfills_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackfillIn"},"example":{"subreddit":"Bitcoin","date_from":"2024-01-01","date_to":"2024-01-31","max_posts":500,"comment_limit":10}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{},"example":{"backfill_id":"backfill-id","status":"pending"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}],"tags":["历史回溯"],"description":"创建一个较小规模的历史回溯任务，适合几百到几千条帖子。大规模需求建议使用大额历史导出。\n\n认证：请求头 `X-API-Key: sk_live_xxx`。"}},"/v1/exports/collectors/{collector_id}":{"get":{"summary":"导出采集任务结果","operationId":"export_collector_v1_exports_collectors__collector_id__get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"collector_id","in":"path","required":true,"schema":{"type":"string","title":"Collector Id"}},{"name":"format","in":"query","required":false,"schema":{"type":"string","default":"json","title":"Format"}},{"name":"include_comments","in":"query","required":false,"schema":{"type":"boolean","default":true,"title":"Include Comments"}},{"name":"date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date From"}},{"name":"date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date To"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["导出"],"description":"下载定时采集任务的 JSON 或 CSV ZIP 结果。format=json 或 csv。\n\n认证：请求头 `X-API-Key: sk_live_xxx`。"}},"/v1/exports/backfills/{job_id}":{"get":{"summary":"导出历史回溯结果","operationId":"export_backfill_v1_exports_backfills__job_id__get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}},{"name":"format","in":"query","required":false,"schema":{"type":"string","default":"json","title":"Format"}},{"name":"include_comments","in":"query","required":false,"schema":{"type":"boolean","default":true,"title":"Include Comments"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["导出"],"description":"下载历史回溯任务的 JSON 或 CSV ZIP 结果。format=json 或 csv。\n\n认证：请求头 `X-API-Key: sk_live_xxx`。"}}},"components":{"schemas":{"BackfillIn":{"properties":{"subreddit":{"type":"string","title":"Subreddit"},"max_posts":{"type":"integer","maximum":5000.0,"minimum":1.0,"title":"Max Posts","default":100},"comment_limit":{"type":"integer","maximum":50.0,"minimum":0.0,"title":"Comment Limit","default":0},"date_from":{"type":"string","format":"date","title":"Date From"},"date_to":{"type":"string","format":"date","title":"Date To"}},"type":"object","required":["subreddit","date_from","date_to"],"title":"BackfillIn"},"BulkHistoryExportIn":{"properties":{"title":{"anyOf":[{"type":"string","maxLength":160},{"type":"null"}],"title":"Title"},"subreddit":{"type":"string","maxLength":100,"minLength":2,"title":"Subreddit"},"subreddits":{"items":{"type":"string"},"type":"array","title":"Subreddits"},"date_from":{"type":"string","format":"date","title":"Date From"},"date_to":{"type":"string","format":"date","title":"Date To"},"include_posts":{"type":"boolean","title":"Include Posts","default":true},"include_comments":{"type":"boolean","title":"Include Comments","default":true},"include_metadata":{"type":"boolean","title":"Include Metadata","default":false},"export_profile":{"type":"string","title":"Export Profile","default":"monthly_raw"},"comment_scope":{"type":"string","title":"Comment Scope","default":"all"}},"type":"object","required":["subreddit","date_from","date_to"],"title":"BulkHistoryExportIn"},"CollectorIn":{"properties":{"subreddit":{"type":"string","maxLength":100,"minLength":1,"title":"Subreddit"},"interval_minutes":{"type":"integer","title":"Interval Minutes","default":60},"sort":{"type":"string","title":"Sort","default":"new"},"comment_limit":{"type":"integer","maximum":50.0,"minimum":0.0,"title":"Comment Limit","default":10},"keywords":{"items":{"type":"string"},"type":"array","title":"Keywords"}},"type":"object","required":["subreddit"],"title":"CollectorIn"},"CollectorStatusIn":{"properties":{"active":{"type":"boolean","title":"Active"}},"type":"object","required":["active"],"title":"CollectorStatusIn"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"APIKeyHeader":{"type":"apiKey","description":"Customer API key","in":"header","name":"X-API-Key"}}},"tags":[{"name":"系统状态","description":"服务健康检查。"},{"name":"账号与额度","description":"查看当前 API Key 对应账号的套餐、额度和剩余量。"},{"name":"实时数据","description":"读取 Reddit 当前帖子和评论，适合实时监控和轻量查询。"},{"name":"用户数据","description":"按 Reddit 用户名读取该用户公开发布的帖子和评论。"},{"name":"大额历史","description":"读取或创建大范围历史数据任务，适合百万级帖子和评论交付。"},{"name":"采集任务","description":"创建和管理持续运行的社区采集任务。"},{"name":"历史回溯","description":"创建较小范围的历史回溯任务，并导出结果。"},{"name":"导出","description":"下载采集任务或历史回溯任务的 JSON/CSV 结果。"}]}