> ## Documentation Index > Fetch the complete documentation index at: https://docs.molesignal.com/llms.txt > Use this file to discover all available pages before exploring further. # API 目录 > 当前 MoleSignal HTTP API 家族，以及保护各家族的权限或作用域。 除特别说明外，所有产品 API 都使用 `/api/v1` 前缀。本目录按当前路由家族分组；具体示例页面说明常见请求。 | 家族 | 代表路径 | 用途 | | ------ | ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | | 健康 | `/healthz`、`/readyz`、`/version`、顶层 `/metrics` | 存活、就绪、构建信息与 Prometheus 指标。 | | 身份验证 | `/auth/signin`、`/auth/signup`、`/auth/tokens`、`/auth/sso/*` | 会话、API Token、OIDC 与 SAML。 | | 首页与引导 | `/home/overview`、`/onboarding/sample-data`、`/instance` | 工作区激活、首批样例数据与公开实例发现。 | | IAM | `/iam/permissions`、`/iam/capabilities`、`/iam/role-bindings`、`/roles`、`/users`、`/teams`、`/orgs` | 访问能力目录、身份、成员关系与工作区切换。 | | 偏好与设置 | `/workspace/preferences`、`/settings/*`、`/billing/*` | 个人偏好、工作区默认值、运行策略与受支持的计费配置。 | | 采集 | `/intake/{type}/{stream}`、`/logs`、`/metrics`、`/traces`、兼容接收器 | 原生 JSON、OTLP HTTP 与协议兼容采集。 | | 查询 | `/query`、`/query/stream`、`/query/jobs`、`/query/running` | SQL、PromQL、流式查询、异步任务与取消。 | | APM | `/apm/overview`、`/apm/services`、`/apm/transactions`、`/apm/dependencies`、`/apm/errors` | 从 trace 派生的服务 RED 指标、事务、依赖、错误、部署与投影健康状态。 | | 探索元数据 | `/metrics/catalog`、`/log_patterns`、`/annotations` | 指标发现、复用日志模式与有时间范围的注解。 | | 数据流 | `/streams`、`/streams/{id}`、`/streams/{id}/settings` | 数据流生命周期与运行设置。 | | 仪表盘 | `/dashboards`、`/folders`、`/dashboards/variables/resolve` | 仪表盘、文件夹与变量。 | | 告警 | `/alerts/rules`、`/alerts/incidents`、`/schedules`、`/alerts/mutes`、`/notify/connectors`、`/notify/policies`、`/notify/deliveries` | 检测、响应、值班与通知。 | | 数据处理 | `/functions`、`/scheduled_pipelines`、`/connectors`、`/extend_tables` | 转换、数据管道、目标端与数据扩展。 | | 报告 | `/scheduled_reports`、`/report_templates` | 报告内容、计划、预览与投递历史。 | | 文件与产物 | `/files/download`、`/files/stream/{token}` | 创建限定范围下载 Token，并流式交付产物。 | | RUM | `/rum/*`、`/rum/sessions/*`、`/debug-artifacts` | 浏览器与移动端遥测、回放、错误、关联链路、Source Map 与原生符号。 | | 性能剖析 | `/profiles`、`/profiles/intake`、`/profiles/flamegraph`、`/profiles/diff` | 剖析采集、下载、火焰图与对比。 | | Web 关联 | `/web/search`、`/web/topology`、`/web/trace/*`、`/web/correlation/*` | 产品搜索与跨信号视图。 | | 共享 | `/resource_shares`、`/public/share/*`、顶层 `/s/{token}` | 已登录、跨组织与受限公开共享。 | | 安全与治理 | `/audit`、`/cipher_keys`、`/regex_patterns`、`/auth/jwt/*`、`/domains` | 审计查询、加密、复用规则、签名密钥轮换与托管域名。 | | 集群运维 | `/clusters`、`/clusters/{id}/org_map`、`/node/drain` | 远程集群、组织映射、节点可见性与优雅排空。 | | Agent | `/agent/chat`、`/agent/investigations`、`/agent/automations`、`/agent/approvals`、`/agent/settings/*` | Mole Agent、证据、工作流、供应商、提示词、工具与 MCP 管理。 | | 商业控制 | `/marketplace/*`、`/model_prices` | Marketplace、试用或计费集成与模型成本目录。 | | 平台系统 | `/system/platform-admins`、`/system/telemetry`、`/system/license`、`/system/audit` | 受保护的 `_sys` 管理。 | ## 授权模型 端点可以要求： * `streams.query` 或 `alerts.manage` 等组织权限； * `sys.telemetry.read` 等平台权限； * `agent` 等许可证授权能力； * 资源级所有权或关系/授权； * 仅能访问一个资源的公开共享会话。 不要根据展示角色推断授权。请查询 `/api/v1/iam/capabilities` 获取实际生效的权限与功能快照。 ## 事实来源 维护中的 OpenAPI 文件位于 `molesignal/docs/api/openapi.yaml`。部分快速演进的功能在 `src/api/http/routes/` 中拥有比精简 OpenAPI 概览更多的路由。两者不一致时，以服务器路由和 Handler 契约为准，并应在同一变更中更新文档。 了解基础 URL、Bearer 身份验证、分页、错误与请求约定。