错误码
所有错误响应的结构都相同。请以 HTTP 状态和 error.code 为准;error.message 是便于阅读的英文文本,可能会变化。
错误格式
{
"detail": "…",
"error": {
"code": "api.cursor_invalid",
"message": "The cursor is malformed or was issued for different filters.",
"details": {"parameter": "cursor"},
"request_id": "01JB7Q2M4X9V3K8T5N6P0R1S2A",
"doc_url": "https://developers.sursa.com/errors/api.cursor_invalid"
}
}error.code 是本页列出的错误码;error.request_id 与 X-Request-Id 头的值一致;error.doc_url 指向本页。
access_requests
- 409access_requests.closed该访问申请已有审批结果
- 400access_requests.invalid{reason}
- 404access_requests.not_found未找到访问申请或回答
- 403access_requests.not_person访问申请仅对用户开放,API 密钥或“View as”模式下不可用
analytics
- 403analytics.admins_only分析功能仅对组织管理员开放
- 422analytics.invalid_period期间无效:{reason}
announcements
- 422announcements.audience_required请至少选择一个用户组或用户
- 403announcements.author_only只有作者可以执行此操作
- 422announcements.invalid_viewview 必须为 inbox、my_sent、all_sent 或 my_scheduled
- 404announcements.not_found未找到公告
- 409announcements.not_sent该公告尚未发送
- 422announcements.note_too_long备注不能超过 700 个字符
- 422announcements.scheduled_past发送日期必须是将来的时间
answers
- 400answers.empty_question问题为空
- 429answers.engine_busy回答服务繁忙;请在 {retry_after} 秒后重试
- 409answers.external_ai_disabled组织已禁用外部处理,没有外部处理就无法生成此回答
- 400answers.last_message_not_user最后一条消息必须来自用户
- 404answers.no_collections没有可读取的合集
- 422answers.scope_invalid无法应用提问范围:{reason}
api
- 400api.cursor_invalid游标格式错误,或是为其他筛选条件签发的
- 400api.expand_invalidexpand[] 无效:{reason}
- 410api.gone此 API 路由已停用;请参阅 docs/api/CHANGELOG.md
- 409api.idempotency_in_progress使用此 Idempotency-Key 的请求仍在处理中;请稍后重试
- 400api.idempotency_key_invalidIdempotency-Key 头必须是 1 到 255 个可打印 ASCII 字符
- 409api.idempotency_mismatch此 Idempotency-Key 已用于另一个不同的请求
- 400api.metadata_invalidmetadata 无效:{reason}
- 404api.not_found未找到
- 413api.payload_too_large请求体过大
- 429api.quota_exceeded组织已用完本期的 API 请求配额
- 429api.rate_limited请求过多;请稍后重试
api_keys
- 400api_keys.data_profile_not_applicabledata_profile 不适用于 admin 角色;管理员密钥可以看到组织的所有数据
- 401api_keys.expiredAPI 密钥已过期
- 403api_keys.feature_disabled组织的套餐不包含 API 令牌
- 400api_keys.invalid_cidrsallowed_cidrs 必须是网络列表,例如 10.0.0.0/8:{reason}
- 400api_keys.invalid_collectionscollection_ids 必须列出组织的合集:{reason}
- 400api_keys.invalid_expiresexpires_at 必须是 ISO 8601 格式的将来时间
- 400api_keys.invalid_scopesscopes 必须是由 read、write、admin、system 组成的列表:{reason}
- 403api_keys.ip_not_allowed不允许从此网络使用该 API 密钥发出请求
- 403api_keys.mcp_only个人 MCP 密钥只能用于 /mcp 接口
- 404api_keys.not_found未找到密钥
- 403api_keys.scopeAPI 密钥没有权限范围 {scope}
api_logs
- 404api_logs.not_foundAPI 日志中未找到该请求,或该请求已超过 14 天
auth
- 403auth.admin_required需要 admin 角色
- 403auth.editor_required需要 editor 角色
- 401auth.not_authenticated未通过身份验证
- 403auth.system_scope系统管理员无权访问组织数据
authz
- 403authz.forbidden需要权限 '{permission}'
- 400authz.group_key_invalid用户组键无效:只能包含拉丁字母、数字、'_' 和 '-',最多 80 个字符,以字母开头
- 409authz.group_key_taken用户组键 '{key}' 已被使用
- 409authz.group_kind_immutable这是内置用户组;其成员由系统计算,无法编辑,也无法删除
- 409authz.group_managed_externally该用户组由身份提供方(SCIM)管理
- 404authz.group_not_found未找到用户组
- 409authz.last_owner对象上必须至少保留一个 '{role}'
- 409authz.legacy_admin_single_user_onlyadmin 角色只能授予用户,不能授予用户组
- 409authz.managed_by_source该对象的权限由其数据源管理
- 400authz.role_key_invalid角色键无效:只能包含拉丁字母、数字、'_' 和 '-',最多 64 个字符,以字母开头
- 409authz.role_key_taken角色键 '{key}' 已被使用
- 404authz.role_not_found未找到角色
- 400authz.role_scope_mismatch角色 '{key}' 不能在 {object_type} 上授予
- 409authz.role_system_immutable系统角色不能更改或删除
- 400authz.subject_requiredgroup_id 和 user_id 必须且只能提供一个
- 400authz.unknown_permission未知权限 '{permission}'
- 400authz.user_not_in_org在组织中未找到该用户
- 400authz.view_required适用于对象的角色必须包含 COLLECTION_VIEW
billing
- 402billing.seats_exceeded订阅的全部 {purchased} 个席位均已占用({reserved} 个活跃用户和待接受的邀请)。要邀请更多人员,请在“Billing”(计费)页面上增加席位。
cards
- 400cards.archive_empty压缩包中没有受支持的文档
- 400cards.archive_encrypted压缩包已加密;请上传没有密码的压缩包
- 400cards.archive_invalid该文件不是 zip 压缩包,或压缩包已损坏
- 404cards.archive_job_not_found未找到压缩包解压作业
- 413cards.archive_too_large解压后的压缩包超过了允许的大小
- 413cards.archive_too_many_files压缩包中的文件数量超过了允许的上限
- 400cards.bulk_invalid{reason}
- 403cards.category_whole_access只有拥有整个文档的访问权限才能更改分类
- 404cards.comment_not_found未找到评论,或该评论不是您的
- 403cards.content_whole_access只有拥有整个文档的访问权限才能替换卡片内容
- 403cards.delete_whole_access只有拥有整个文档的访问权限才能删除卡片
- 403cards.duplicate_restricted存在一份相同的文档,但您的数据权限档案无法完整访问它
- 400cards.export_formatformat 必须为 pdf、docx 或 md
- 409cards.external_id_takenexternal_id '{external_id}' 已被组织中的另一张卡片使用
- 409cards.indexing_in_progress该卡片正在索引中
- 400cards.invalid_folder_filterfolder=none 需要同时提供 collection 参数
- 400cards.invalid_kind_filterkind 必须是 ('file', 'text', 'connector') 之一
- 400cards.invalid_orderorder 必须为 'asc' 或 'desc'
- 400cards.invalid_owner_filterowner 必须为 'me'、'none' 或用户 ID
- 400cards.invalid_sortsort 必须是 ('created_at', 'updated_at', 'title', 'size', 'verified_at', 'trust', 'due') 之一
- 400cards.invalid_status_filterstatus 必须是 ('processing', 'ready', 'error', 'archived', 'all') 之一
- 400cards.invalid_type_filtertype 必须为 'table' 或 'text'
- 400cards.invalid_verification_filterverification 必须是 ('verified', 'needs_verification', 'stale') 之一
- 409cards.managed_by_source该卡片由数据源管理;请在数据源中更改文档(对于自定义数据源,请重新推送)
- 403cards.no_access对该卡片没有 {action} 权限
- 409cards.no_original_file该卡片未存储原始文件
- 404cards.not_found未找到卡片
- 400cards.review_requires_asyncreview=true 需要 async=true:解析预览会在作业等待期间显示
- 403cards.sensitivity_admin_only只有管理员可以降低敏感级别或移动敏感卡片
- 404cards.table_not_found未找到表格
- 400cards.unknown_table_part未知表格 '{table_id}'
- 415cards.unsupported_format不支持格式 {ext};允许的格式:['.adoc', '.asciidoc', '.bmp', '.csv', '.docx', '.eml', '.htm', '.html', '.jpeg', '.jpg', '.markdown', '.md', '.ods', '.pdf', '.png', '.pptx', '.tif', '.tiff', '.tsv', '.txt', '.webp', '.xls', '.xlsm', '.xlsx']
- 403cards.verify_forbidden只有负责人、核实人或管理员可以核实该卡片
- 400cards.verify_user_account_required核实需要用户账号,不能使用 API 密钥
- 404cards.version_not_found未找到版本
catalog
- 404catalog.icon_not_found该服务没有图标
- 404catalog.service_not_found未知服务 '{service_id}'
categories
- 409categories.exists分类已存在
- 400categories.not_deletable未找到分类,或该分类为系统分类
- 404categories.not_found未找到分类
- 400categories.unknown未知分类 '{key}'
collections
- 403collections.admin_fields更改合集的访问设置、敏感级别、默认值和搜索设置需要 admin 角色
- 409collections.index_outdated该合集的索引已过时;请先升级索引:使用 upgrade_index: true 调用 PATCH /v1/collections/{name} 会重新索引该合集
- 409collections.indexing_in_progress该合集的文档正在索引中;请在索引完成后再更改搜索设置
- 400collections.invalid_name合集名称无效:1-64 个字符,只能包含拉丁字母、数字、'_' 和 '-'
- 403collections.no_access对合集 '{name}' 没有 '{action}' 权限
- 403collections.no_write_access对合集 '{name}' 没有写入权限
- 404collections.not_found未找到合集 '{name}'
comments
- 422comments.body_required必须填写评论内容
- 403comments.forbidden您无法更改此评论
- 404comments.not_found未找到评论
- 400comments.reply_to_reply只能回复首条评论
- 409comments.resolved_edit已解决的评论无法编辑
conversations
- 422conversations.invalid_cursor游标无效
- 404conversations.not_found未找到对话
- 422conversations.title_empty标题不能为空
drafts
- 409drafts.already_requested该草稿已提交发布申请;在等待审阅期间可以继续编辑
- 409drafts.card_deleted该草稿对应的卡片已被删除
- 409drafts.card_published该草稿开始后,卡片已被发布或更改;请从已发布的版本开始新的草稿
- 422drafts.content_json_invalidcontent_json 必须是包含 schemaVersion(字符串)和 doc(对象)的对象,最大 500000 字节
- 409drafts.deleted_by_collaborator另一位共同作者已删除该草稿;要继续编辑,请新建草稿
- 409drafts.exists您已有该卡片的草稿
- 422drafts.invalid_scopescope 必须为 mine、all 或 orphaned
- 403drafts.not_collaborator只有共同作者或管理员可以更改该草稿
- 404drafts.not_found未找到草稿
- 409drafts.not_requested该草稿尚未申请发布
- 403drafts.publish_forbidden您没有向该合集发布内容的权限
- 422drafts.scheduled_past计划日期必须是将来的时间
- 422drafts.title_required标题为必填项
events
- 404events.not_found未找到事件,或事件已超过 30 天
files
- 410files.expired文件已过期
- 422files.infected文件 {filename} 未通过病毒扫描,已被拒绝:{signature}
- 422files.invalid_expiry_filterexpiry 必须是 active、expiring、expired 之一
- 422files.invalid_kind_filterkind 必须是 pdf、xlsx、csv、docx、md 之一
- 422files.invalid_origin_filterorigin 必须是 answer、card、insights、list 之一
- 409files.no_expiry该文件没有过期日期,会一直保留
- 404files.not_found未找到文件
- 409files.not_regenerable{reason}
- 422files.preview_failed无法预览该文件:{reason}
- 404files.regeneration_required此文件是在主地址生成的,包含 API 专用地址不返回的详细信息;请使用 POST /v1/files/{file_id}/regenerate 重新生成,或在主地址下载
- 409files.removed该文件已在过期后被删除;请改为重新生成
- 503files.scan_unavailable病毒扫描暂不可用;请稍后重试
- 413files.too_large文件 {filename} 超过了 {limit} 的上传限制
- 415files.type_mismatch文件 {filename} 与其类型不符:扩展名 {extension},声明的类型 {declared},实际内容 {detected}
finance
- 503finance.engine_unavailable助手不可用:{reason}
- 413finance.export_too_large导出内容超过 {limit} 行:请缩小筛选范围
- 403finance.forbidden您的数据权限档案无权访问财务数据
- 400finance.invalid{reason}
folders
- 400folders.appearance_invalidcolor 必须是 blue、violet、emerald、amber、orange、rose、cyan、slate 之一;icon 必须是分类键或 lock
- 400folders.card_collection_mismatch卡片和文件夹属于不同的合集
- 409folders.cycle不能将文件夹移入其自身或其子文件夹
- 409folders.depth_exceeded移动后的文件夹深度超过了上限 3
- 404folders.not_found未找到文件夹
- 400folders.parent_mismatch父文件夹属于另一个合集
- 400folders.sibling_not_foundprev_sibling_id 必须为 'first'、'last' 或目标父文件夹中某个同级文件夹的 ID
- 400folders.title_invalid文件夹标题必须为 1 到 200 个字符
insights
- 403insights.finance_forbidden您的数据权限档案无权访问财务数据
- 400insights.invalid_period{name}:期间格式应为 YYYY-MM,实际为 '{value}'
- 404insights.no_data没有可用于知识洞察的表格数据
- 400insights.period_ordersince 不能晚于 until
internal
- 500internal.error服务器内部错误
jobs
- 409jobs.already_processing该作业已在处理中,无法再从队列中移除
- 409jobs.cancel_failed无法从队列中移除该作业
- 410jobs.cancel_unsupported该作业在支持取消功能之前排入队列;请等待其完成
- 422jobs.invalid_filter{reason}
- 404jobs.not_found未找到作业
- 409jobs.not_queued只能从队列中移除排队中的作业(该作业的状态为 {status})
limits
- 402limits.cards组织已达到 {limit} 张卡片的上限{plan}。请删除不再需要的卡片,或请系统管理员提高上限。
- 429limits.concurrent_answers组织已有 {used} 个回答正在生成(上限 {limit});请几秒钟后重试
- 429limits.questions组织已用完每 24 小时 {limit} 个问题的上限{plan}。大约 {wait} 后可以再次提问。如需更多额度,请联系系统管理员提高上限。
- 402limits.sources组织已达到 {limit} 个数据源的上限{plan}。请删除不再需要的数据源,或请系统管理员提高上限。
- 402limits.sources_instant组织的套餐不包含即时更新{plan};该数据源仍按计划同步。
- 402limits.storage存储空间不足:组织已使用 {used} / {limit} GB{plan},此文件还需要 {amount}。请删除不再需要的卡片或文件,或请系统管理员提高上限。
- 402limits.users组织已达到 {limit} 个用户的上限{plan}(包括活跃用户和待接受的邀请)。请停用不再需要的账号或撤销不再需要的邀请,或请系统管理员提高上限。
notifications
- 422notifications.invalid_filter{reason}
oauth
- 403oauth.operation_not_allowedOAuth 应用令牌不能使用此操作
- 401oauth.token_expired访问令牌已过期;请用刷新令牌获取新的访问令牌
oauth_apps
- 400oauth_apps.invalid{reason}
- 400oauth_apps.invalid_redirect_uri不允许使用重定向 URI '{uri}':请使用 https;http 仅限 localhost;或使用反向域名形式的应用协议,且不能带片段
- 400oauth_apps.invalid_scope未知权限范围 '{scope}'
- 409oauth_apps.not_confidential该应用为公开应用:没有客户端密钥,也没有客户端凭据访问权限
- 404oauth_apps.not_found未找到 OAuth 应用
- 409oauth_apps.too_many组织已有 {max} 个 OAuth 应用
oauth_authorizations
- 404oauth_authorizations.not_found未找到应用授权
org
- 403org.deleted该组织已被删除
- 404org.not_found未找到组织
- 403org.suspended该组织已被暂停:登录已关闭,数据仍保留;请联系管理员
profiles
- 400profiles.unknown未知数据权限档案 '{key}'
quality
- 400quality.filter_invalid{reason}
- 409quality.followup_closed该知识缺口已关闭
- 404quality.followup_not_found未找到处理中的知识缺口
query
- 422query.invalid_date日期无效:{value}
questions
- 400questions.answer_empty回答为空,无法保存为卡片
- 404questions.answer_table_not_found回答中未找到该表格
- 404questions.dataset_not_found未找到数据集
- 400questions.export_formatformat 必须是 pdf、xlsx、csv、docx、md 之一
- 400questions.export_rowsrows 必须列出从 0 开始的表格行号,以逗号分隔,范围用连字符表示(0-4,7)
- 422questions.invalid_feedback_filterfeedback 必须为 positive、negative、rated、none 或 unanswered
- 422questions.invalid_q_fieldq_field 必须为 all 或 question
- 422questions.invalid_view_as_filterview_as 必须为 only 或 exclude
- 404questions.not_found未找到问题
- 400questions.save_card_error{reason}
sources
- 400sources.connection_kind_mismatch该连接用于 {kind},不适用于此数据源
- 404sources.connection_not_found未找到数据源连接
- 403sources.connection_not_usable该连接属于其他用户或已停用
- 403sources.feature_disabled组织的套餐不包含一键连接数据源功能
- 400sources.folder_invalid该文件夹不在数据源的合集中,或您无法向其中添加卡片
- 400sources.invalid_config数据源设置无效:{reason}
- 400sources.kind_not_allowed_for_keyAPI 密钥只能创建和更改自定义数据源;其他数据源请在浏览器中连接
- 404sources.not_found未找到数据源
- 422sources.push_batch_rejected由于部分文档被拒绝,该批次未被应用;请查看 details.results
- 400sources.push_document_invalid{reason}
- 404sources.push_document_not_found在数据源中未找到该文档
- 409sources.push_initial_required请先完成首次同步,再进行增量同步
- 401sources.push_key_invalid数据源 API 密钥缺失、无效或已撤销
- 404sources.push_key_not_found未找到数据源 API 密钥
- 409sources.push_sync_closed同步已关闭或已过期;请新建一个同步
- 404sources.push_sync_not_found未找到同步
- 409sources.push_sync_open该数据源已有另一个未关闭的同步;请关闭它或等待其过期
- 409sources.push_too_many_documents数据源已达到您套餐的文档数量上限
- 400sources.push_unsupported该数据源不接受推送的文档(只有自定义数据源接受)
tasks
- 400tasks.invalid_scopescope 必须为 'mine' 或 'team'
- 403tasks.team_forbidden团队视图仅对管理员和核实人开放
- 400tasks.user_account_required个人任务属于用户账号,不属于 API 密钥
uploads
- 409uploads.already_used该上传已被使用
- 422uploads.checksum_mismatchSHA-256 校验和不匹配({reason})
- 410uploads.expired该上传已过期
- 409uploads.incomplete该上传缺少 {missing_count} 个分段
- 404uploads.not_found未找到上传
- 409uploads.not_ready该上传尚未就绪(状态 {status})
- 400uploads.part_invalid上传分段 {n} 无效:{reason}
- 422uploads.purpose_mismatch该上传是为 {purpose} 创建的,而不是为 {expected} 创建的
- 422uploads.rejected上传被拒绝:{reason}
- 409uploads.state_conflict处于 {status} 状态的上传不接受此操作
- 503uploads.storage_unavailable文件存储暂时不可用;请稍后重试
- 413uploads.too_large文件超过了 {limit_bytes} 字节的上传限制
- 415uploads.unsupported_format扩展名为 {extension} 的文件不能为 {purpose} 上传
users
- 422users.display_name_empty显示名称不能为空
- 409users.email_taken组织中已存在使用该电子邮件的用户
- 400users.inactive_assignment不能指派未启用的用户
- 409users.last_admin组织必须保留至少一名活跃的管理员
- 409users.managed_by_scim该账号由您的身份提供方(SCIM)管理;请在那里更改
- 404users.not_found未找到用户
- 400users.not_in_org在组织中未找到该用户
- 400users.offboard_target移交对象必须是同一组织中除被办理离职交接者以外的活跃用户
- 403users.password_not_allowed该账号通过您的身份提供方登录,没有密码;管理员可以通过重置链接为其添加密码
- 400users.unknown_or_inactive未知或未启用的用户:{ids}
- 400users.update_invalid{reason}
- 409users.username_taken组织中已存在使用该用户名的用户
users_import
- 422users_import.csv_invalid该文件不是有效的 CSV:{reason}
- 422users_import.empty文件在表头之后没有任何行
- 422users_import.no_email_column表头中没有电子邮件列(email、e-mail、mail);找到的列:{columns}
- 413users_import.too_many_rows文件有 {rows} 行;每次最多导入 {limit} 行
validation
- 422validation.failed请求校验失败
verification
- 409verification.absolute_expired核实日期已过:请先设置新的核实周期,再进行核实
- 409verification.archived该卡片已归档
- 400verification.date_required需要一个将来的日期
- 422verification.invalid_actionkind 必须为 view 或 copy
- 400verification.invalid_interval核实周期必须在 1 到 3650 天之间
- 422verification.invalid_modemode 必须为 up_first 或 all
- 400verification.invalid_reasonreason 必须为 manual、automation 或 requested
- 422verification.invalid_sort未知的排序字段或排序方向
- 400verification.invalid_type核实类型必须为 relative、absolute 或 manual
- 409verification.self_remind您是该卡片唯一的核实人:没有可提醒的人
- 400verification.verifier_required至少需要一名核实人
view_as
- 403view_as.admin_key_requiredX-View-As 需要具有 admin 角色的 API 密钥
- 400view_as.invalid_headerX-View-As 必须为 <profile>[:viewer|verifier|editor],且数据权限档案必须存在
- 403view_as.read_only查看模式:以其他档案身份查看时无法进行更改
webhooks
- 400webhooks.access_invalidWebhook 的角色、有效负载模式、数据权限档案、合集或标签无效
- 400webhooks.auth_invalid出站授权必须是带令牌的 bearer,或带用户名和密码的 basic
- 403webhooks.collections_outside_key该 API 密钥仅限部分合集:请列出 Webhook 的 collection_ids,且全部属于该密钥的合集
- 404webhooks.delivery_not_found未找到 Webhook 投递
- 400webhooks.description_too_longWebhook 描述超过 200 个字符
- 409webhooks.endpoint_disabled该 Webhook 已停用;请先启用它
- 409webhooks.event_not_permittedWebhook 现在不会收到此事件:其角色、数据权限档案、合集或标签已不再允许,因此不会重复投递
- 400webhooks.events_required请至少订阅一个事件
- 403webhooks.feature_disabled组织的套餐不包含 Webhook
- 400webhooks.headers_invalid自定义 Webhook 头无效:最多 10 个头,名称只能包含字母、数字和连字符且不能使用保留名称,值最长 1024 字节
- 400webhooks.invalid_urlWebhook 的 url 必须是不含凭据的绝对 https 地址
- 404webhooks.not_found未找到 Webhook
- 400webhooks.overlap_invalid轮换过渡期必须在 0 到 168 小时之间
- 400webhooks.private_addressWebhook 主机解析到私有或保留的网络地址
- 400webhooks.redeliver_invalid重新投递的时间段必须在最近 30 天内,且 since 早于 until;状态必须为 success、exhausted 或 cancelled
- 409webhooks.too_many一个组织最多可以有 20 个 Webhook
- 400webhooks.unknown_event未知的 Webhook 事件 {type}
- 400webhooks.unresolvableWebhook 主机无法解析