ErrorEnvelopeOut

顶层错误响应体：{"error": {...}}。

error object必填

每个失败的请求都会返回的 error 对象。

typeType必填

错误的大类，由 HTTP 状态码决定。始终存在。

可能的取值： [api_error, authentication_error, invalid_request_error, permission_error, rate_limit_error]

codeCode必填

稳定的、供程序判断的错误码，客户端据此分支。始终存在。

稳定的、供程序判断的错误码，客户端可以据此分支（不同于给人看的 message）。错误码可能随时间增加，所以遇到不认识的错误码，请按它的 HTTP 状态码大类处理。按状态码列出的错误码：

• 400: bad_request
• 401: invalid_secret, invalid_token, project_disabled, token_expired, user_disabled
• 403: permission_denied, project_disabled, user_disabled
• 404: file_expired, file_not_found, generation_not_found, not_found, project_not_found, session_not_found, user_not_found
• 405: method_not_allowed
• 409: call_in_progress, conflict, idempotency_conflict, idempotency_in_progress, session_busy, session_ended, session_not_realtime, session_not_taskable
• 413: file_too_large, payload_too_large
• 422: unsupported_media_type, validation_failed
• 429: insufficient_available_credits, insufficient_credits, rate_limited
• 500: internal
• 502: upstream_error
• 503: service_unavailable

messageMessage必填

给人看的英文简述，用于展示或记录日志；不要据此分支。始终存在。

paramParam可为 null

导致失败的请求字段名（如有）：校验错误（422）时一定有；其他针对单个字段的错误也会有（例如文件找不到、文件过大）。

details object[]可为 null

每个出错的请求字段一条。仅在校验错误（422）时出现。

Array [

paramParam必填

出错的请求字段的点分路径，例如 attachments[0].file_id。

messageMessage必填

该字段的问题所在。

]

request_idRequest Id必填

把这次响应与服务端日志关联起来；也会通过 X-Request-Id 响应头返回。始终存在。

ErrorEnvelopeOut

{
  "error": {
    "type": "api_error",
    "code": "string",
    "message": "string",
    "param": "string",
    "details": [
      {
        "param": "string",
        "message": "string"
      }
    ],
    "request_id": "string"
  }
}