跳转到主要内容
POST
cURL
使用此 endpoint 通过 API 创建简单问卷。按用户应回答问题的顺序发送 form_elements 数组。Didit 会为您构建内部问卷图谱。 该 API 仅支持简单的线性问卷。请勿发送 graph、branches、next 或条件规则。

必填字段

  • title 是内部问卷名称。
  • languages 必须包含 en。
  • form_elements 必须至少包含一个问题。
  • 每个表单元素都需要 element_type 和已翻译的 label。
您还可以为表单元素添加可选的已翻译 description,作为其帮助文本。除 separator 外,所有元素类型都支持该字段,并会在问卷报告中以该条目的 description 返回。

元素类型

请使用小写值,例如 short_text、multiple_choice、email、file_upload 或 date_picker。大写枚举值(例如 SHORT_TEXT)也可以使用。 对于 dropdown、single_choice 和 multiple_choice,请添加 options。如果省略选项的 value,Didit 会根据标签自动生成。

字段验证

为 short_text、long_text 或 number 元素添加可选的 validation 对象,即可对用户的回答强制执行格式。这对于有严格格式要求的标识符很有用,例如税号、国民身份证号或卡号。用户填写字段时即会进行验证(未通过验证时用户无法继续),提交时 API 还会再次强制执行。
响应中包含 questionnaire_id。请妥善保存,因为将问卷添加到工作流时,需要将其用作 questionnaire_uuid。

授权

x-api-key
string
header
必填

您的应用 API 密钥,可在 Business Console 的“开发者 -> API 密钥”中获取。主密钥拥有完整访问权限。指定名称的密钥可设置作用域:针对每个资源设为无权限、只读或读写,限定于特定工作流或已通过的会话、限定于 IP 地址列表,以及设置到期日期。401 表示密钥错误、已撤销或已过期;403 表示未发送密钥、密钥无权访问该资源或操作,或请求来自其 IP 列表之外的地址;在会话路由上返回 404 表示该会话不在该密钥允许的工作流或状态范围内。没有媒体访问权限的密钥获取到的图片、视频和 PDF URL 将为 null;没有会话写入权限的密钥获取到的会话链接和 token 将为 null。请参阅 https://docs.didit.me/console/api-keys。

请求体

application/json

创建简单的线性问卷。API 会在内部将 form_elements 转换为内部问卷图谱。

title
string
必填

问卷的内部名称。

languages
string[]
必填

每个标签中包含的语言。必须包含 en。

示例:
form_elements
object[]
必填

用户应该看到的严格顺序的问题。不支持分支和条件字段。

Minimum array length: 1
description
string | null
default_language
string

默认语言。必须包含在 languages 中。

示例:

"en"

is_active
boolean
默认值:true
status
enum<string>

省略此字段可创建已发布且可用于工作流的问卷。

可用选项:
draft,
published

响应

问卷已创建。响应包含 questionnaire_id — 请保存该 ID,以便在工作流或将来的更新/删除调用中引用此问卷。

从 GET、POST(创建)和 PATCH(更新)endpoint 返回的完整问卷详情。

questionnaire_id
string<uuid>

问卷的唯一标识符。在工作流中引用该问卷或在后续更新/删除请求中使用此 ID。

title
string
description
string | null
languages
string[]
default_language
string
is_active
boolean
is_simple_questionnaire
boolean
graph
object

包含 start_node 和 nodes 映射的图谱结构。

sections
object[]

分组到各节中的问卷内容(源自图谱)。

questionnaire_group_id
string<uuid>

用于将同一问卷的所有版本分组的稳定标识符。

version
integer
status
enum<string>
可用选项:
draft,
published
published_at
string<date-time> | null
is_editable
boolean

当问卷仍可就地编辑(草稿版本)时为 true。

最后修改于 2026年11月7日