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

# 获取配置字段的类型定义

> 返回 Chat API 中 context、sandboxId、toolContext 参数的字段类型说明



## OpenAPI

````yaml api-reference/openapi-huajune.json get /config-schema
openapi: 3.1.0
info:
  title: 华骏智能招聘 API
  description: 华骏智能招聘助手的 Open API 接口文档，提供模型管理、对话、工具、配置等功能
  version: 1.0.0
  contact:
    name: 华骏科技
    url: https://huajune.duliday.com
servers:
  - url: https://huajune.duliday.com/api/v1
    description: 生产环境
security:
  - bearerAuth: []
tags:
  - name: Models
    description: 模型管理相关接口
  - name: Chat
    description: AI 对话相关接口
  - name: Tools
    description: 工具管理相关接口
  - name: Configuration
    description: 配置管理相关接口
paths:
  /config-schema:
    get:
      tags:
        - Configuration
      summary: 获取配置字段的类型定义
      description: 返回 Chat API 中 context、sandboxId、toolContext 参数的字段类型说明
      operationId: getConfigSchema
      responses:
        '200':
          description: 成功获取配置字段定义
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigSchema'
          headers:
            X-Correlation-Id:
              description: 请求关联 ID
              schema:
                type: string
        '401':
          $ref: '#/components/responses/UnauthorizedError'
components:
  schemas:
    ConfigSchema:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          type: object
          properties:
            context:
              type: object
              description: 上下文字段定义。每个字段包含 type、required、description。
              additionalProperties:
                $ref: '#/components/schemas/FieldDefinition'
            sandboxId:
              $ref: '#/components/schemas/FieldDefinition'
            toolContext:
              $ref: '#/components/schemas/FieldDefinition'
    FieldDefinition:
      type: object
      required:
        - type
        - required
        - description
      properties:
        type:
          type: string
          description: 字段的 TypeScript 类型表示
          example: string
        required:
          oneOf:
            - type: boolean
            - type: string
          description: 是否必需。可以是布尔值（false 表示可选），或描述字符串（如 "按工具需要"）。
          example: false
        description:
          type: string
          description: 字段说明
          example: 首选品牌名称
  responses:
    UnauthorizedError:
      description: 未授权 - API Key 无效或缺失
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                example: Unauthorized
              message:
                type: string
                example: Invalid or missing API key
              statusCode:
                type: integer
                example: 401
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 使用 Bearer Token 进行认证，格式：`Bearer YOUR_API_KEY`

````