---
title: "获取图片属性字典"
method: GET
path: "/image-attrs/schema"
tags: ["知识库"]
---

# 获取图片属性字典

`GET /image-attrs/schema`

## Request

- Base URL: `/api/v1` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/api/v1/image-attrs/schema`
- Auth: one of:
  - API key in header `Authorization`
  - API key in header `X-API-Key`

返回当前版本的图片属性注册表、提示词版本和默认动作。全局只读，不绑定知识库。

## Response `200`

OK

- object
  - `data` InternalHandlerImageAttrSchemaData
    - `attributes` GithubComTencentWeKnoraInternalTypesAttrSpec[]
      - `consumers` string[]: downstream steps that read this attribute
      - `description` string: one line explaining what the attribute measures
      - `inject` 'always' | 'on_demand'
      - `internal` boolean: Internal marks an attribute that steers this pipeline's own scheduling rather than describing what the image holds. Such attributes are still observed and persisted — the values are what justify a scheduling decision after the fact — but they are kept out of the gallery's filter surface, where they would only add noise: no operator wants to filter a library by "how much margin is left around the text".
      - `label` string: human-readable name for the settings panel
      - `name` string: stable key, e.g. "contain.text"
      - `question` string: sentence shown to the model in the describe round
      - `type` 'extent' | 'presence'
      - `values` GithubComTencentWeKnoraInternalTypesAttrValue[]: ordered low->high for extent attrs
        - `description` string: sentence explaining the value
        - `label` string: short on-screen name
        - `value` string: raw machine value, never localized
    - `default_actions` GithubComTencentWeKnoraInternalTypesImageActionsConfig
      - `ocr` GithubComTencentWeKnoraInternalTypesImageOCRAction
        - `on` GithubComTencentWeKnoraInternalTypesImageAttrCondition[]: On is the list of attribute conditions that enable OCR. Matching any one turns OCR on.
          - `is` string
          - `prop` string
    - `prompt` string
    - `version` string
  - `success` boolean

## Changes

- **2026-10-14** `7909fe890afd`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/tencentblueking/apis/weknora-api/changes/image-attrs/schema/get.md)

---

[API](https://skmtc.dev/tencentblueking/apis/weknora-api.md) - [All operations](https://skmtc.dev/tencentblueking/apis/weknora-api/llms.txt) - [OpenAPI document](https://skmtc.dev/tencentblueking/apis/weknora-api/revisions/685d1f9fce30?raw)
