Generate Outline

Developing

POST

/docmee/v1/api/ppt/generateOutline

Request

Header Params

Body Params text/plain

Example

Example:{ // Method 1: Create via subject "subject": "xxx", // Subject (choose either this or dataUrl) // Method 2: Create via file content "dataUrl": "https://xxx", // Data URL, returned by the file content parsing API (choose either this or subject) "prompt": null // User request (less than 50 characters) }

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/docmee/v1/api/ppt/generateOutline' \
--header 'token: {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
  // Method 1: Create via subject
  "subject": "xxx", // Subject (choose either this or dataUrl)
  // Method 2: Create via file content
  "dataUrl": "https://xxx", // Data URL, returned by the file content parsing API (choose either this or subject)

  "prompt": null // User request (less than 50 characters)
}'

Responses

🟢200Success

application/json

Body

Example

{
  "text": "",
  "status": 1 // Status: -1 Exception, 1 Parsing file, 3 Generating, 4 Completed
}

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

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

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

...

{
	"text": "",
	"status": 4,
	"result": {
		"level": 1,
		"name": "Theme",
		"children": [
			{
				"level": 2,
				"name": "Chapter",
				"children": [
					{
						"level": 3,
						"name": "Page Title",
						"children": [
							{
								"level": 4,
								"name": "Content Title"
							}
						]
					}
				]
			}
		]
	}
}

Modified at 2025-07-23 10:01:53

Parse file content

Generate outline content