Create doc - Coda

Creates a new Coda doc, optionally copying an existing doc. Note that creating a doc requires you to be a Doc Maker in the applicable workspace (or be auto-promoted to one).

curl --location --request POST 'http://dev-cn.your-api-server.com/docs' \ --header 'Content-Type: application/json' \ --data-raw '{ "title": "Project Tracker", "sourceDoc": "iJKlm_noPq", "timezone": "America/Los_Angeles", "folderId": "fl-ABcdEFgHJi", "initialPage": { "pageContent": { "canvasContent": { "format": "html", "content": "<p><b>This</b> is rich text</p>" }, "type": "canvas" }, "name": "Launch Status", "subtitle": "See the status of launch-related tasks.", "iconName": "rocket", "imageUrl": "https://example.com/image.jpg", "parentPageId": "canvas-tuVwxYz" } }'

{ "icon": { "name": "string", "type": "string", "browserLink": "https://cdn.coda.io/icons/png/color/icon-32.png" }, "docSize": { "totalRowCount": 31337, "tableAndViewCount": 42, "pageCount": 10, "overApiSizeLimit": false }, "published": { "mode": "view", "description": "Hello World!", "browserLink": "https://coda.io/@coda/hello-world", "imageLink": "string", "discoverable": true, "earnCredit": true, "categories": [ "Project Management" ] }, "folder": { "id": "fl-1Ab234", "browserLink": "https://coda.io/docs?folderId=fl-1Ab234", "name": "My docs", "type": "folder" }, "workspace": { "id": "ws-1Ab234", "organizationId": "org-2Bc456", "browserLink": "https://coda.io/docs?workspaceId=ws-1Ab234", "name": "My workspace", "type": "workspace" }, "id": "AbCDeFGH", "href": "https://coda.io/apis/v1/docs/AbCDeFGH", "browserLink": "https://coda.io/d/_dAbCDeFGH", "name": "Product Launch Hub", "owner": "user@example.com", "ownerName": "Some User", "createdAt": "2018-04-11T00:18:57.946Z", "updatedAt": "2018-04-11T00:18:57.946Z", "workspaceId": "ws-1Ab234", "folderId": "fl-1Ab234", "requestId": "abc-123-def-456", "type": "doc", "sourceDoc": { "id": "AbCDeFGH", "href": "https://coda.io/apis/v1/docs/AbCDeFGH", "browserLink": "https://coda.io/d/_dAbCDeFGH", "type": "doc" } }

请求参数

Body 参数application/json

Payload for creating a new doc.

title

string

可选

Title of the new doc. Defaults to 'Untitled'.

示例值:

Project Tracker

sourceDoc

string

可选

An optional doc ID from which to create a copy.

示例值:

iJKlm_noPq

timezone

string

可选

The timezone to use for the newly created doc.

示例值:

America/Los_Angeles

folderId

string

可选

The ID of the folder within which to create this doc. Defaults to your "My docs" folder in the oldest workspace you joined; this is subject to change. You can get this ID by opening the folder in the docs list on your computer and grabbing the folderId query parameter.

示例值:

fl-ABcdEFgHJi

initialPage

object

可选

Payload for creating a new page in a doc.

pageContent

PageCreateContent

可选

Content that can be added to a page at creation time, either text (or rich text) or a URL to create a full-page embed.

name

string

可选

Name of the page.

示例值:

Launch Status

subtitle

string

可选

Subtitle of the page.

示例值:

See the status of launch-related tasks.

iconName

string

可选

Name of the icon.

示例值:

rocket

imageUrl

string

可选

Url of the cover image to use.

示例值:

https://example.com/image.jpg

parentPageId

string

可选

The ID of this new page's parent, if creating a subpage.

示例值:

canvas-tuVwxYz

示例

返回响应

🟢201Info about the created doc.

application/json

Body

The result of a doc creation.

icon

object (Icon)

可选

Info about the icon.

name

string

必需

Name of the icon.

type

string

必需

MIME type of the icon

browserLink

string <url>

必需

Browser-friendly link to an icon.

示例值:

https://cdn.coda.io/icons/png/color/icon-32.png

docSize

object (DocSize)

可选

The number of components within a Coda doc.

totalRowCount

number

必需

The number of rows contained within all tables of the doc.

示例值:

31337

tableAndViewCount

number

必需

The total number of tables and views contained within the doc.

示例值:

pageCount

number

必需

The total number of page contained within the doc.

示例值:

overApiSizeLimit

boolean

必需

If true, indicates that the doc is over the API size limit.

示例值:

false

published

object (DocPublished)

可选

Information about the publishing state of the document.

mode

enum<string>

必需

Which interaction mode the published doc should use.

枚举值:

viewplayedit

description

string

可选

Description of the published doc.

示例值:

Hello World!

browserLink

string

必需

URL to the published doc.

示例值:

https://coda.io/@coda/hello-world

imageLink

string

可选

URL to the cover image for the published doc.

discoverable

boolean

必需

If true, indicates that the doc is discoverable.

示例值:

true

earnCredit

boolean

必需

If true, new users may be required to sign in to view content within this document. You will receive Coda credit for each user who signs up via your doc.

示例值:

true