You need to enable JavaScript to run this app.
导航
返回结构
最近更新时间:2024.07.10 15:11:41首次发布时间:2024.07.10 15:11:41
模型/智能体调用 API

正常返回

视请求的接口而定,不同的接口会有不同的结果返回。

异常返回

调用失败的返回示例如下:

{
    "error": {
        "code": "MissingParameter",
        "message": "The request failed because it is missing one or multiple required parameters. Request id: 02172046847020185d65de0b597df************************",
        "param": "input",
        "type": "BadRequest"
    }
}

当流式输出过程中出现错误时,错误信息将在以 data: 开头的数据块中返回。字段解释如下:

参数名称类型描述示例值
typeString错误类型BadRequest
codeString错误码MissingParameter
paramString请求参数缺失或不合法导致请求失败时,未通过校验的具体参数名称model
messageString错误提示信息The request failed because it is missing one or multiple required parameters.
其他 API

正常返回

接口调用成功后,会返回 RequestId 和接口返回参数。HTTP 状态码为 200。

{
    "ResponseMetadata": {
        "RequestId": "202010201722300102****",
        "Action": "{Action}",
        "Version": "{Version}",
        "Service": "{Service}",
        "Region": "{Region}"
    },
    "Result":"..."
}

请求被正常处理后,返回中会包含ResponseMetadataResult两部分,Result视请求的接口而定,不同的接口会有不同的 Result 返回。

字段解释如下:

字段类型描述
RequestIdStringRequestId 为每次 API 请求的唯一标识。
ActionString请求的接口名,属于请求的公共参数。
VersionString请求的版本号,属于请求的公共参数。
ServiceString请求的服务,属于请求的公共参数。
RegionString服务所在的地域信息,属于请求的公共参数。火山方舟服务所在的地域请参见地域和访问域名

异常返回

接口调用出错后,会返回 RequestId 和错误信息。HTTP 状态码为 4xx 或者 5xx。您可以根据接口错误代码 Code 和错误信息 Message,参考公共错误码和接口错误码排查错误。

{
    "ResponseMetadata": {
        "RequestId": "202010201722300102****",
        "Action": "{Action}",
        "Version": "{Version}",
        "Service": "{Service}",
        "Region": "{Region}",
        "Error": {
            "Code": "InvalidActionOrVersion",
            "Message": "Could not find operation GetUserById for version 2024-01-01"
        }
    }
}

相较于成功结果,错误结果将不再有 Result 部分,而 ResponseMetadata 中将额外出现 Error 字段,包括 CodeMessage

字段解释如下:

字段类型描述
CodeStringCode内容为具体的错误码,您可根据错误码查询文档自助解决问题。
MessageStringMessage描述了错误发生的具体原因,供您排查问题参考。