> ## Documentation Index
> Fetch the complete documentation index at: https://enterprise-docs.dify.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# 获取标注列表

> 获取应用的标注分页列表。支持关键词搜索筛选。



## OpenAPI

````yaml /zh/3.10.x/develop/api/openapi_chatflow.json get /apps/annotations
openapi: 3.0.1
info:
  title: 工作流编排对话型应用 API (对话流 API)
  description: >-
    对话流应用支持会话持久化，允许将之前的聊天记录作为响应的上下文。对话流应用使用 `advanced-chat`
    模式，提供工作流级别的流式事件，用于详细的执行追踪，包括节点开始、完成、迭代和工作流生命周期。
  version: 1.0.0
servers:
  - url: https://{api_base_url}
    description: 工作流编排对话型应用 API 的基础 URL。
    variables:
      api_base_url:
        default: api.dify.ai/v1
        description: API 基础 URL 的主机与路径，不含 `https://` 前缀。
security:
  - ApiKeyAuth: []
tags:
  - name: 对话流
    description: 对话流应用的操作，包括对话消息、工作流执行详情和事件流。
  - name: 文件操作
    description: 文件上传和预览操作。
  - name: 终端用户
    description: 终端用户信息相关操作。
  - name: 消息反馈
    description: 用户反馈操作。
  - name: 会话管理
    description: 与管理会话相关的操作。
  - name: 语音与文字转换
    description: 文字转语音和语音转文字操作。
  - name: 应用配置
    description: 获取应用设置和信息的操作。
  - name: 标注管理
    description: 与管理标注直接回复相关的操作。
  - name: 人工介入
    description: 暂停等待人工输入的工作流恢复操作。
paths:
  /apps/annotations:
    get:
      tags:
        - 标注管理
      summary: 获取标注列表
      description: 获取应用的标注分页列表。支持关键词搜索筛选。
      operationId: getAnnotationListCn
      parameters:
        - name: page
          in: query
          description: 分页页码。
          required: false
          schema:
            type: integer
            default: 1
        - name: limit
          in: query
          description: 每页条目数。
          required: false
          schema:
            type: integer
            default: 20
        - name: keyword
          in: query
          description: 按问题或回答内容筛选标注的关键词。
          required: false
          schema:
            type: string
      responses:
        '200':
          description: 成功获取标注列表。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnnotationListResponse'
              examples:
                annotationList:
                  summary: 响应示例
                  value:
                    data:
                      - id: a1b2c3d4-5678-90ab-cdef-1234567890ab
                        question: What is Dify?
                        answer: >-
                          Dify is an open-source LLM application development
                          platform.
                        hit_count: 5
                        created_at: 1705407629
                    has_more: false
                    limit: 20
                    total: 1
                    page: 1
components:
  schemas:
    AnnotationListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AnnotationItem'
          description: 当前页面的标注项列表。
        has_more:
          type: boolean
          description: 如果当前结果集之后还有更多页面，则为 `true`。
        limit:
          type: integer
          description: 每页条目数。
        total:
          type: integer
          description: 匹配查询条件的标注总数。
        page:
          type: integer
          description: 当前页码。
    AnnotationItem:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: 标注唯一标识符。
        question:
          type: string
          nullable: true
          description: 触发该标注的问题文本。
        answer:
          type: string
          nullable: true
          description: 标注被匹配时返回的预定义回答。
        hit_count:
          type: integer
          nullable: true
          description: 该标注被匹配并作为回复返回的次数。
        created_at:
          type: integer
          format: int64
          nullable: true
          description: 创建时间戳（Unix 纪元秒）。
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API_KEY
      description: >-
        API Key 认证。对于所有 API 请求，请在 `Authorization` HTTP 头中包含您的 API Key，并加上
        `Bearer ` 前缀。示例：`Authorization: Bearer {API_KEY}`。**强烈建议将 API Key
        存储在服务端，不要在客户端共享或存储，以避免 API Key 泄漏导致严重后果。**

````