SubmitDeepWriteTask

Updated at:

You can submit a deep writing task. You can provide information such as questions, instructions, and attachments, based on the topic you want to research or analyze. The system schedules and executes this task in the background.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

aimiaobi:SubmitDeepWriteTask

create

*All Resource

*

NoneNone

Request syntax

POST  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

WorkspaceId

string

No

llm-1setzb9xb8m11vrc

Input

string

Yes

The user's question.

北京2025年新能源汽车发展趋势

Instructions

string

No

The instructions.

请根据北京新能源汽车在汽车品牌、新车发布、能源等方面进行分析

Files

array<object>

No

A list of attachments.

object

No

FileKey

string

No

The Object Storage Service (OSS) address of the attachment.

oss://default/aimiaobi-poc/aimiaobi/deep-write-upload/1_1/xxx.txt

FileDescription

string

No

A description of the attachment.

附件的说明

FileName

string

No

The name of the attachment.

附件的名称

AgentOrchestration

object

No

The agent orchestration options.

DataCollectorAgent

object

No

The data collection agent.

Name

string

No

The name.

DataCollectorAgent

DataAnalystAgent

object

No

The data analysis agent.

Name

string

No

The name.

DataAnalystAgent

EnableSearch

boolean

No

Specifies whether to enable retrieval.

true

ReporterAgent

object

No

The reporter agent.

Name

string

No

The name.

ReporterAgent

EnableCitation

boolean

No

Specifies whether to enable citations.

Response elements

Element

Type

Description

Example

object

The response schema.

RequestId

string

The ID of the request.

xxxxx

Success

boolean

Indicates whether the request was successful.

true

Code

string

The error code.

DataNotExists

Message

string

The error message.

错误消息

HttpStatusCode

integer

The HTTP status code.

400

Data

object

The task response object.

TaskId

string

The task ID.

xbabac91-fdad-44d6-95ce-******

Status

string

The status of the task.

Valid values:

  • in_progress :

    In progress

  • queued :

    Queued

  • cancelled :

    Canceled

  • completed :

    Completed

  • failed :

    Failed

queued

Examples

Success response

JSON format

{
  "RequestId": "xxxxx",
  "Success": true,
  "Code": "DataNotExists",
  "Message": "错误消息",
  "HttpStatusCode": 400,
  "Data": {
    "TaskId": "xbabac91-fdad-44d6-95ce-******",
    "Status": "queued"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.