任务和结果
每个 SocQ 采集都作为后台任务运行:
精简模式(Compact)通过 socq_execute 提交任务;类型化工具(Typed tools)通过 socq_youtube_comments 等工具提交任务。两者返回相同的任务数据结构。
等待任务
MCP 默认不会等待任务完成。可以为 socq_execute 设置 wait_seconds,或为类型化工具设置 _wait_seconds,让单次调用最多等待 30 秒。
如果任务状态仍为 queued 或 running,请保留任务 ID 并调用 socq_get_task:
CLI 可以轮询同一任务,而无需保持 API 请求打开:
客户端超时不会取消 SocQ 任务。请使用同一个任务 ID 继续查询,不要重复提交采集任务并产生额外费用。
安全地重试提交
如果网络或客户端故障可能导致重复提交,请使用幂等密钥。24 小时内,用户、密钥、API 端点和输入参数完全相同时,服务器会返回原任务;如果输入参数不同却重复使用同一密钥,则会返回冲突错误。任务尚未结束时,即使超过 24 小时也会继续受到保护,直到任务结束。
读取任务结果
成功任务在 results.items 中返回记录,并统一使用 REST、MCP、CLI、SDK 与 Skills 共用的资源级固定 Schema。
结果会保留已声明的可空字段,并排除数据提供方特有的实现细节。可选的 fields 参数最多接受 50 个逗号分隔的顶层字段或点路径。只有调用方未通过投影请求字段时,该字段才会省略。
Typed MCP 工具使用 _result_fields,CLI 使用可选的 --result-fields。
成功任务会在 results.items 中返回标准化记录。MCP 每页默认返回 25 条,最多返回 100 条。
当 has_more 为 true 时,把 next_cursor 原样传给下一次 socq_get_task 调用。当游标为空或已经取得所需数量的结果时停止。
下载来源文件(高级)
使用 socq_get_files 或 CLI 检索原始 JSONL 导出:
文件 URL 可能过期。大多数集成应使用分页任务结果;来源文件仅用于高级处理和问题排查。
有关任务状态和响应字段,请参阅任务状态和结果 和结果文件。