Enter writing instructions to quickly generate content.
Operation description
Access Instructions:
- The OpenAPI portal is incompatible with the Server-Sent Events (SSE) inference protocol. Therefore, you cannot directly debug this operation. For an example of how to call the API using an SDK, see Miaobi Best Practices.
- Click this link to download the latest version of the Java asynchronous SDK.
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
Actionelement 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
Resourceelement of the policy. - For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the
Resourceelement of the policy.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the
- 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:RunQuickWriting | create | *All Resource
| None | None |
Request syntax
Request parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| WorkspaceId | string | Yes | xxxx | |
| TaskId | string | No | Task ID. Reuse the same task ID for multi-turn conversations. | 3f7045e099474ba28ceca1b4eb6d6e21 |
| Articles | array<object> | No | Referenced articles | Collection |
object | No | Article object | Article object | |
| Title | string | No | Article title | Article title |
| Content | string | No | Article content | Article content |
| Url | string | No | Article URL | |
| Prompt | string | Yes | Other writing parameters. Choose either prompt or writingParams. | Please output in English |
| SearchSources | array<object> | No | Use the specified search source list. | |
object | No | Search source object | ||
| Code | string | No | SystemSearch: system-built-in search. CustomSemanticSearch: custom semantic index search. ThirdSearch: third-party API search. | SystemSearch |
| DatasetName | string | No | Unique identifier of the data source | QuarkCommonNews |
Response elements
Element | Type | Description | Example |
|---|---|---|---|
object | BaseLlmResponse | ||
| Header | object | Response header | |
| ErrorCode | string | Error code | Error code |
| ErrorMessage | string | Error message | Error message |
| Event | string | SSE event. task-started: started, task-finished: finished, task-failed: failed. | task-started |
| SessionId | string | Session ID | 3f7045e099474ba28ceca1b4eb6d6e21 |
| StatusCode | integer | HTTP response code | 400 |
| TaskId | string | Task ID | 3f7045e099474ba28ceca1b4eb6d6e21 |
| TraceId | string | Trace ID | Full-link trace ID |
| Payload | object | Response body | |
| Output | object | Output | |
| Text | string | Text generation result | Text generation result |
| Usage | object | Token usage information | |
| InputTokens | integer | Number of input tokens used | 78 |
| OutputTokens | integer | Number of output tokens | 34 |
| TotalTokens | integer | Total number of tokens | 38 |
| RequestId | string | Request ID | 3f7045e099474ba28ceca1b4eb6d6e21 |
| End | boolean | Indicates whether the response package has ended. | false |
Examples
Success response
JSON format
Error codes
HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 403 | NoPermission | You are not authorized to perform this action. | Please check the workspaceId assignment |