Skip to main content
交互式 API 参考由 OpenAPI 契约生成,位于侧边栏的 API Reference 组下。契约由 API 自身在 GET /api/v1/openapi.json 提供,并存储在本仓库根目录的 openapi.json 中。 API 资源名为 session 是历史原因;它代表产品中的一个持久化项目(包含地图状态、图层、文件、对话历史和报告的工作区)。 完整端点列表从源码仓库生成,存储在 source/api-routes.json 中。如果本页看起来过期了,请重新生成 source pack:
然后同步生成的文件:

公开 API 端点

请求/响应 schema 见侧边栏交互式 API Reference 组(由 OpenAPI 契约生成)。/api/internal/* 属于平台内部接口,不属于公开 API,这里不列出。

支持的上传类型

POST /api/v1/sessions/{id}/files 接受以下文件类型(每个文件最大 50MB,可通过 UPLOAD_MAX_SIZE_MB 配置):

能力范围

API key 通过能力范围(capability scopes)授予访问权限。["*"](或空的 scopes 数组)授予全部访问权限;否则只允许列出的范围。

地图操作

POST /api/v1/sessions/{id}/map/actions 接受一个操作对象数组。每个操作需要 type;参数取决于类型。也接受 map.* 前缀的旧别名(例如 map.flyTo)。 不带 layer_id 的 add_tile_layer 会由后端持久化(按 URL 去重),并在响应中返回创建的图层 id。

视图与相机

图层

底图与遮罩

系统与通知