Kanorio
Kanorio 开发者

API 参考

Sections

Management API: GET /sections

本页只有英文版。API 参考、Webhook 事件和更新日志保持英文，与代码中的字段名称、错误码一致。
Base URL https://app.kanorio.com/api/v1ErrorsPagination

Describe sections

GET/sections
betadefault (120/minute per token)

List the section (module) types that can be placed on a page, with an English name, description, category and, in full mode, the JSON Schema (draft 2020-12) each section object must satisfy. Call this before pages.replace_sections. Without `types` you get a compact summary of all types; pass `types` (or detail=full) to receive the schemas. Pass `websiteId` to learn which types are available on that website's plan (sets `available`); this requires the editor:enter scope on that website. Errors: FORBIDDEN (no access to websiteId or website does not exist), WEBSITE_NOT_FOUND.

Parameters

  • websiteIdstring · query

    Optional. When set, `available` reflects that website's plan; needs editor:enter.

  • typesstring[] · query

    Return only these section types, with full JSON Schemas.

  • detail"summary" | "full" · query

    summary (default when `types` is omitted) or full (schemas included).

Response 200

  • sectionsobject[]required
  • sections[].typestringrequired
  • sections[].namestringrequired
  • sections[].descriptionstring | nullrequired
  • sections[].categoriesstring[]required
  • sections[].minimumPlanstring | nullrequired
  • sections[].availableboolean | nullrequired
  • sections[].schemaobject
  • conventionsobjectrequired

Errors

  • FORBIDDEN 403 · no access to websiteId or website does not exist
  • WEBSITE_NOT_FOUND 404

MCP tool sections_describe

curl -X GET "https://app.kanorio.com/api/v1/sections?types=hero%2Cfaq&detail=summary" \
  -H "Authorization: Bearer $KANORIO_TOKEN"
Response
{
  "sections": [
    {
      "type": "hero",
      "name": "Hero",
      "description": "Full-width opening section with headline, subtitle, image and buttons.",
      "categories": [
        "intro"
      ],
      "minimumPlan": null,
      "available": true
    },
    {
      "type": "faq",
      "name": "FAQ",
      "description": "Question and answer list.",
      "categories": [
        "content"
      ],
      "minimumPlan": null,
      "available": true
    }
  ],
  "conventions": {
    "brandFirst": "Set brand colors and buttons before filling pages."
  }
}