# 生成大纲(免费

**方法**: `POST`
**路径**: `/docmee/v1/api/ppt/generateOutline`

## 请求参数

### Header 参数

```text
Content-Type
string
必需
示例:
application/json
Authorization
string
可选
默认值:
Bearer {{YOUR_API_KEY}}
```

### Body 参数 application/json

```text
subject
string
必需
示例
{
"subject"
:
"string"
}
```

## 请求示例代码

### Shell

```bash
curl --location --request POST '/docmee/v1/api/ppt/generateOutline' \
--header 'Authorization: Bearer {{YOUR_API_KEY}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "subject": "string"
}'
```

## 返回响应

### 🟢 200 成功

**内容类型**: `application/json`

#### 响应结构

```text
object
```

#### 示例

```json
{
  "text": "",
  "status": 1 // 状态：-1异常 1解析文件 3生成中 4完成
}

{ "text": "# ", "status": 3 }

{ "text": " ", "status": 3 }

{ "text": "主题", "status": 3 }

...

{
	"text": "",
	"status": 4,
	"result": {
		"level": 1,
		"name": "主题",
		"children": [
			{
				"level": 2,
				"name": "章节",
				"children": [
					{
						"level": 3,
						"name": "页面标题",
						"children": [
							{
								"level": 4,
								"name": "内容标题"
							}
						]
					}
				]
			}
		]
	}
}
```