RunAiHelperWriting - AI帮写

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
aimiaobi:RunAiHelperWritingcreate
*全部资源
*

请求语法

POST /quanmiao/aimiaobi/runAiHelperWriting HTTP/1.1

请求参数

名称类型必填描述示例值
WorkspaceIdstring

业务空间 ID

llm-xxxxx
WritingScenestring

写作场景:government(政务)、media(传媒)、market(营销)、office(办公)、custom(自定义)

media
WritingStylestring

写作文体唯一标识 KEY,可通过 ListWritingStyles 接口获取对应写作场景下的文体列表

通知
Promptstring

提示词,需要帮写的主题

请帮我写一篇关于人工智能发展趋势的文章
PromptModestring

提示词模式,如:PE:高级模式,Template:模板模式

Template
DistributeWritingboolean

是否分步骤写作文体

false
WritingParamsobject

上一次表单的写作参数,键值对形式

string

写作参数 KEY VALUE

{"topic":"写作主题"}

示例数据

{
    "WorkspaceId": "llm-xxx",
    "WritingScene": "office",
    "WritingStyle": "speech",
    "Prompt": "关于“人工智能伦理与社会影响”主题的演讲稿"
}

返回参数

名称类型描述示例值
object

Schema of Response

Headerobject

SSE 响应头信息

ErrorCodestring

错误码

InvalidParameter
ErrorMessagestring

错误信息

参数错误
Eventstring

事件类型

result-generated
SessionIdstring

会话 ID

session-xxxxx
StatusCodeinteger

状态码

200
TaskIdstring

任务 ID

task-xxxxx
TraceIdstring

链路追踪 ID

1813ceee-7fe5-41b4-87e5-982a4d18cca5
Payloadobject

响应载荷

Outputobject

输出内容

Textstring

生成文本

人工智能正在深刻改变我们的生活...
WritingParamsobject

AI 帮写的写作参数

string

KEY VALUE 形式的键值对

{"topic":"写作主题xxx"}
Usageobject

Token 使用量

InputTokenslong

输入 Token 数

256
OutputTokenslong

输出 Token 数

1024
TotalTokenslong

总 Token 数

1280
RequestIdstring

请求 ID

1813ceee-7fe5-41b4-87e5-982a4d18cca5
HttpStatusCodestring

HTTP 状态码

200
Codestring

业务状态码

successful
Messagestring

返回信息

success
Successboolean

是否成功

true

示例

正常返回示例

JSON格式

{
  "Header": {
    "ErrorCode": "InvalidParameter",
    "ErrorMessage": "参数错误",
    "Event": "result-generated",
    "SessionId": "session-xxxxx",
    "StatusCode": 200,
    "TaskId": "task-xxxxx",
    "TraceId": "1813ceee-7fe5-41b4-87e5-982a4d18cca5"
  },
  "Payload": {
    "Output": {
      "Text": "人工智能正在深刻改变我们的生活...",
      "WritingParams": {
        "key": {
          "topic": "写作主题xxx"
        }
      }
    },
    "Usage": {
      "InputTokens": 256,
      "OutputTokens": 1024,
      "TotalTokens": 1280
    }
  },
  "RequestId": "1813ceee-7fe5-41b4-87e5-982a4d18cca5",
  "HttpStatusCode": 200,
  "Code": "successful",
  "Message": "success",
  "Success": true
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2025-12-19新增 OpenAPI查看变更详情