FetchParseDocumentLayoutTask
Retrieve the layout task result.
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
No authorization for this operation. If you encounter issues with this operation, contact technical support.
Request syntax
POST HTTP/1.1
Request parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| WorkspaceId | string | Yes | Unique identifier of the Alibaba Cloud Model Studio workspace: Get workspaceId | llm-xxxx |
| TaskId | string | Yes | Content to be formatted | 29ae0ba84c1c4cc694d0f4f1aead8005 |
Response elements
Element | Type | Description | Example |
|---|---|---|---|
object | Schema of Response | ||
| RequestId | string | Id of the request | 1813ceee-7fe5-41b4-87e5-982a4d18cca5 |
| Success | boolean | Indicates whether the call succeeded. | true |
| Code | string | Status code | successful |
| HttpStatusCode | integer | HTTP status code | 200 |
| Message | string | Error message | successful |
| Data | object | Business data | |
| TaskStats | string | Task status | PENDING-pending, RUNNING-running, SUCCESSED-success, SUSPENDED-suspended, FAILED-failed, CANCELLED-cancelled |
| LayoutResult | object | Structured content after formatting | |
| Elements | array<object> | Returned element data | |
object | Array object | ||
| Index | number | Index order of each element | 1 |
| Type | string | Type | The supported types are as follows: HEADING("heading"), H1("Heading 1"), H2("Heading 2"), H3("Heading 3"), H4("Heading 4"), H5("Heading 5"), H6("Heading 6"), PARAGRAPH("paragraph"), SIGNATURE("signature"), FOOTNOTE("footnote"), TABLE("table"), CODE_BLOCK("code block"), ATTACHMENT("attachment"), BLOCKQUOTE("blockquote"); |
| Content | string | Content | 1. Major work progress this month\n |
| FormatContent | string | For headings, content with heading numbers removed | Major work progress this month |
Examples
Success response
JSON format
{
"RequestId": "1813ceee-7fe5-41b4-87e5-982a4d18cca5",
"Success": true,
"Code": "successful",
"HttpStatusCode": 200,
"Message": "successful",
"Data": {
"TaskStats": "PENDING-pending, RUNNING-running, SUCCESSED-success, SUSPENDED-suspended, FAILED-failed, CANCELLED-cancelled",
"LayoutResult": {
"Elements": [
{
"Index": 1,
"Type": "The supported types are as follows:\n HEADING(\"heading\"),\n H1(\"Heading 1\"),\n H2(\"Heading 2\"),\n H3(\"Heading 3\"),\n H4(\"Heading 4\"),\n H5(\"Heading 5\"),\n H6(\"Heading 6\"),\n PARAGRAPH(\"paragraph\"),\n SIGNATURE(\"signature\"),\n FOOTNOTE(\"footnote\"),\n TABLE(\"table\"),\n CODE_BLOCK(\"code block\"),\n ATTACHMENT(\"attachment\"),\n BLOCKQUOTE(\"blockquote\");",
"Content": "1. Major work progress this month\\n",
"FormatContent": "Major work progress this month"
}
]
}
}
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.