Coda

Begin content export

开发环境

POST

/docs/{docId}/pages/{pageIdOrName}/export

Pages

Initiate an export of content for the given page.

请求示例

Python

Shell

JavaScript

Java

curl --location --request POST 'http://dev-cn.your-api-server.com/docs/AbCDeFGH/pages/canvas-IjkLmnO/export' \
--header 'Content-Type: application/json' \
--data-raw '{
    "outputFormat": "html"
}'

响应示例

202 - 示例 1

{
  "id": "AbCDeFGH",
  "status": "complete",
  "href": "https://coda.io/apis/v1/docs/somedoc/pages/somepage/export/some-request-id"
}

请求参数

Path 参数

docId

string

必需

ID of the doc.

示例值:

AbCDeFGH

pageIdOrName

string

必需

ID or name of the page. Names are discouraged because they're easily prone to being changed by users. If you're using a name, be sure to URI-encode it. If you provide a name and there are multiple pages with the same name, an arbitrary one will be selected.

示例值:

canvas-IjkLmnO

Body 参数application/json

Request for beginning an export of page content.

outputFormat

enum<string>

必需

Supported output content formats that can be requested for getting content for an existing page.

枚举值:

htmlmarkdown

示例

返回响应

🟢202Export page content response.

application/json

Body

Response when beginning an export of page content.

string

必需

The identifier of this export request.

示例值:

AbCDeFGH

status

string

必需

The status of this export.

示例值:

complete

href

string

必需

The URL that reports the status of this export. Poll this URL to get the content URL when the export has completed.

示例值:

https://coda.io/apis/v1/docs/somedoc/pages/somepage/export/some-request-id

🟠400400

🟠401401

🟠403403

🟠404404

🟠410410

🟠429429

修改于 2024-03-20 08:13:15

Create a page

Get a page