Sign in

c65a8418f3c8

latestOpenAPI 3.0.0Superhuman Developer Terms2026-08-06124404444.0 KB
Pages

Begin content export

Initiate an export of content for the given page.

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

Path parameters

docIdstring required

ID of the doc.

pageIdOrNamestring required

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.

Request body

outputFormat'html' | 'markdown' required

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

Response

Export page content response.

idstring required

The identifier of this export request.

statusstring required

The status of this export.

hrefstring required

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

Example response

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