View as Markdown
Documenterra icon

Documenterra ACTION

Export Publication

Exports an existing publication to a user-selected format. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Documenterra account once, then configure and run Export Publication from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "documenterra-export-publication",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    documenterra: { authProvisionId: "apn_xxxxxxx" },
    projectId: "Publication ID",
    outputFileName: "Output File Name",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Export Publication inputs
Property Type Description
projectId Publication ID string
The unique identifier for the publication.
Required Dynamic
outputFileName Output File Name string
The full name of the output file. If the output file is saved to Documenterra's file storage (the default), the full file name must be specified, including the file path starting with Storage/ Eg. Storage/export-files/deep-space-1.0-docs.zip.
Required
format Format string
The format of the publication to be exported.
Required

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
documenterra-export-publication
Version
0.0.2
App
Documenterra
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes