§ API REFERENCE

查询能力目录

GET/capabilitiesscope: capabilities:read

查询本机构可调用的 AI 测评、量表测评、综合方案与六维认知;一次返回产品卡片展示字段、统一资源标识、点数价格和托管入口类型。

鉴权:Authorization: Bearer <access_token>。
§ 1

请求信息

GET https://api.lingxiguangnian.com/api/open/v1/capabilities

请求头

参数类型必填说明
AuthorizationstringBearer <access_token>。由 POST /token 换取,有效期 2 小时;api_secret 不得直连业务端点(→ 401)。
§ 2

调用示例

curl "https://api.lingxiguangnian.com/api/open/v1/capabilities" \
  -H "Authorization: Bearer oat_xxxxxxxxxxxxxxxx"
§ 3

返回结果

返回字段

参数类型必填说明
capabilities[].resource_typeenumCAPABILITY_UNIT / SCENE_SOLUTION。
capabilities[].resource_iduuid创建执行时原样传入。
capabilities[].categoryenumAI_ASSESSMENT / SCALE_ASSESSMENT / COMPREHENSIVE_SOLUTION / SIX_DIMENSION_PROFILE。
capabilities[].price_creditsnumber本次执行冻结并在成功后实扣的点数。
capabilities[].cu_iduuid | null兼容字段;方案类为 null。
capabilities[].cu_codestring | null兼容字段;方案类为 null。
capabilities[].namestring能力名称。
capabilities[].cu_typestring能力类型(独立 assessment 不返回)。
capabilities[].launchableboolean是否可经开放 API 创建 runtime launch(终端用户免登作答)。
capabilities[].launch_typestring四类正式产品固定 HOSTED。
capabilities[].launch_paramsobject含统一 entry_endpoint。
capabilities[].unavailable_reasonstring | null不可 launch 原因:UNSUPPORTED_CAPABILITY_TYPE / NO_PUBLISHED_TASK;可 launch 为 null。
capabilities[].content_endpointstring该产品的版本化公开内容与科学信息端点。
capabilities[].summarystring | null目录卡片使用的正式摘要;缺失时为 null,第三方不应自行补写产品事实。
capabilities[].cover_urlstring | null目录卡片封面。
capabilities[].estimated_durationstring | null面向用户的预计体验时长。
capabilities[].content_versionstring | null当前公开内容版本。
capabilities[].updated_atISO datetime | null当前公开内容更新时间。
capabilities[].content_statusenumCOMPLETE / PARTIAL;第三方可据此降级展示。
capabilities[].primary_in_categoryboolean当前 APP 目录内该类别唯一可用产品时为 true;多产品时全部为 false,禁止猜第一条。
totalnumber能力总数。
{
  "success": true,
  "data": {
    "capabilities": [
      {
        "resource_type": "CAPABILITY_UNIT",
        "resource_id": "22222222-2222-4222-8222-222222222222",
        "category": "SCALE_ASSESSMENT",
        "price_credits": 5,
        "cu_id": "22222222-2222-4222-8222-222222222222",
        "cu_code": "CU-SR-PSY-SCL90-STD",
        "name": "症状自评量表",
        "cu_type": "scale",
        "launchable": true,
        "launch_type": "HOSTED",
        "launch_params": { "entry_endpoint": "/api/open/v1/runtime/launch-tokens" },
        "unavailable_reason": null,
        "content_endpoint": "/api/open/v1/capabilities/CAPABILITY_UNIT/22222222-2222-4222-8222-222222222222/content",
        "summary": "用于了解近期心理症状及其严重程度的标准化自评工具。",
        "cover_url": null,
        "estimated_duration": "15分钟",
        "content_version": "v1.0",
        "updated_at": "2026-08-17T00:00:00.000Z",
        "content_status": "COMPLETE",
        "primary_in_category": false
      }
    ],
    "total": 1
  }
}
§ 4

端点错误码

通用鉴权、scope 与限流错误见「使用概述」;下表为本端点专属错误。

HTTPerror_code触发条件
500open_api.capabilities_query_failed能力目录查询失败。
使用说明
  • 四类目录项都走 C 端托管式免登运行;第三方不需要自建量表或方案执行页面。
  • 独立认知评估与认知训练不属于本次正式开放范围。
  • 正式开放类别中,已发布且具有当前有效价格的产品默认可用;机构配置业务目录后按目录进一步收窄。
  • 独立认知评估不进入开放 API 能力目录;请通过场景方案交付。

契约真源:apps/m-master/src/app/api/open/v1/capabilities/route.ts