预约演示免费注册登录

REST API

在您的 Skimle 项目之上构建应用

每个方向一个端点——读或写——覆盖所有项目资源。使用项目级 API 密钥进行身份验证，发送 JSON 操作，接收 JSON 返回。

三步开始使用

从零到您的第一次带鉴权的调用。

1

创建 API 密钥

API 密钥的作用范围限定为单个项目和单一访问级别（只读或可编辑）。

  1. 1. 打开 API 密钥页面
  2. 2. 选择该密钥可访问的项目，并选择只读或可编辑权限
  3. 3. 复制密钥——Skimle 只保存它的哈希值

请立即复制密钥。

完整的密钥值只在创建时显示一次。关闭对话框后，我们这边只留下哈希值——密钥一旦丢失，只能重新签发。

2

发送您的第一个请求

把密钥作为 Bearer 令牌传入，操作放在 JSON 请求体中。所有端点均接收 JSON 并返回 JSON。

curl -X POST https://app.skimle.com/api/skimle-read \
  -H "Authorization: Bearer skm_…r" \
  -H "Content-Type: application/json" \
  -d '{ "action": "get_categories" }'

只读密钥以 r 结尾，仅能调用 /api/skimle-read。可编辑密钥以 e 结尾，两个端点都能调用。

3

打开 API 参考文档

浏览每一个端点的说明、请求结构，并可直接试用。每条路由都接受以 action 为判别字段的联合类型请求体。

打开参考文档读取端点 →写入端点 →

原始的 OpenAPI 3.1 规范可在此获取： /api/openapi.json.

准备好开始构建了吗？

管理您的项目密钥，或了解面向智能体客户端的 MCP 服务器。

创建 API 密钥改用 MCP