SDK reference

Every resource of the client, with its methods. A method takes one flat input object (path and query parameters by name, the request body under body) and an optional init for the call. See Conventions for the shape of inputs and outputs and Errors for what a failed call throws.

apiKeys

pd.apiKeys, 4 methods.

• pd.apiKeys.list: List a workspace's API keys
• pd.apiKeys.create: Create an API key
• pd.apiKeys.revoke: Revoke an API key
• pd.apiKeys.rotate: Rotate an API key

articleGroups

pd.articleGroups, 6 methods.

• pd.articleGroups.list: List articles, one item per content piece
• pd.articleGroups.get: Read one content piece with all its language versions
• pd.articleGroups.delete: Delete every language version of a content piece
• pd.articleGroups.approve: Approve the language versions of a group
• pd.articleGroups.publish: Publish the language versions of a group
• pd.articleGroups.unpublish: Unpublish the language versions of a group

articles

pd.articles, 27 methods.

• pd.articles.create: Create an article
• pd.articles.list: List articles
• pd.articles.duplicate: Duplicate an article
• pd.articles.get: Read an article
• pd.articles.update: Update an article
• pd.articles.delete: Delete an article
• pd.articles.submit: Submit an article for review
• pd.articles.approve: Approve an article
• pd.articles.reject: Record a review decision: rejected
• pd.articles.requestChanges: Record a review decision: changes_requested
• pd.articles.publish: Publish an approved article to its integration
• pd.articles.unpublish: Take a published article back to DRAFT
• pd.articles.transitionTranslations: Submit, approve or publish every language version together
• pd.articles.listReviews: The article's review history
• pd.articles.listVersions: The article's version history
• pd.articles.getVersion: Read one version of an article
• pd.articles.getSources: Research sources and fact checks behind an article
• pd.articles.restoreVersion: Restore an earlier version
• pd.articles.listComments: List comments on an article
• pd.articles.addComment: Comment on an article
• pd.articles.resolveComment: Resolve a comment
• pd.articles.reopenComment: Reopen a resolved comment
• pd.articles.checkDuplicates: Check a title for a possible duplicate before creating an article
• pd.articles.move: Move articles to another project
• pd.articles.setHeroFromUrl: Replace the hero image with a picture from a URL
• pd.articles.setHeroFromFile: Replace the hero image with an uploaded file
• pd.articles.detachHeroFromBody: Take the hero image out of the article body

billing

pd.billing, 8 methods.

• pd.billing.listCreditPackages: The credit packs on sale
• pd.billing.getCredits: Wallet balance, reserved and available
• pd.billing.adjustCredits: Adjust a wallet by hand
• pd.billing.listPlans: The plans on offer
• pd.billing.getSubscription: The plan in force, the subscription, and its invoices
• pd.billing.startSubscriptionCheckout: Start a Stripe checkout for a plan
• pd.billing.openPortal: Open the Stripe billing portal
• pd.billing.startCheckout: Start a Stripe checkout for a credit pack

blog

pd.blog, 4 methods.

• pd.blog.listPosts: The blog's published posts in one language
• pd.blog.listCategories: The categories that have published posts, in one language
• pd.blog.getPost: One published post
• pd.blog.getPostEdit: Where the caller can edit a published post

brandVoices

pd.brandVoices, 4 methods.

• pd.brandVoices.list: List brand voices
• pd.brandVoices.create: Create a brand voice
• pd.brandVoices.update: Update a brand voice
• pd.brandVoices.delete: Delete a brand voice

briefs

pd.briefs, 6 methods.

• pd.briefs.draft: Draft a content brief
• pd.briefs.list: List a project's stored briefs
• pd.briefs.create: Store a content brief
• pd.briefs.get: Read a stored brief
• pd.briefs.update: Update a stored brief
• pd.briefs.delete: Delete a stored brief

calendar

pd.calendar, 4 methods.

• pd.calendar.list: The content calendar over a date range
• pd.calendar.create: Add a calendar item
• pd.calendar.update: Update a calendar item
• pd.calendar.delete: Remove a calendar item

categories

pd.categories, 8 methods.

• pd.categories.list: List categories
• pd.categories.create: Create a category
• pd.categories.update: Rename a category, add or remove a language
• pd.categories.delete: Delete a category
• pd.categories.setForArticle: Set an article's categories
• pd.categories.suggestForArticle: Suggest categories for an article
• pd.categories.suggestForProject: Suggest a starter set of categories for a project
• pd.categories.translate: Suggest names for a category in other languages

contentTemplates

pd.contentTemplates, 4 methods.

• pd.contentTemplates.list: List the content templates available to a workspace
• pd.contentTemplates.create: Create a workspace content template
• pd.contentTemplates.update: Update a workspace content template
• pd.contentTemplates.delete: Delete a workspace content template

dashboard

pd.dashboard, 6 methods.

• pd.dashboard.getAnalytics: Generation and publishing aggregates over a window
• pd.dashboard.getTrends: Credits used and articles created or published, per day or week
• pd.dashboard.getArticleCounts: Article counts by status
• pd.dashboard.listJobs: Running jobs, and those that failed recently
• pd.dashboard.listAudit: Audit trail entries, filtered and paged
• pd.dashboard.getCreditBurn: Credit consumption over recent days

generation

pd.generation, 10 methods.

• pd.generation.estimate: Quote the credit cost of generating this article
• pd.generation.getOutline: The outline awaiting review
• pd.generation.approveOutline: Approve an outline and resume writing
• pd.generation.aiEdit: Expand, shorten, rewrite, simplify or change the tone of a passage
• pd.generation.start: Start generating an article
• pd.generation.getStatus: Generation progress for an article
• pd.generation.cancel: Cancel a running generation
• pd.generation.regenerateImage: Regenerate an image, optionally with a new prompt or style
• pd.generation.updateAsset: Edit an image's alt text, or make it the hero or an inline image
• pd.generation.deleteAsset: Delete an image

ideas

pd.ideas, 5 methods.

• pd.ideas.list: List content ideas
• pd.ideas.create: Create a content idea
• pd.ideas.update: Update a content idea
• pd.ideas.delete: Delete a content idea
• pd.ideas.generate: Suggest content ideas for a project

integrations

pd.integrations, 4 methods.

• pd.integrations.list: List publishing integrations
• pd.integrations.create: Connect a publishing target
• pd.integrations.update: Update an integration
• pd.integrations.delete: Disconnect an integration

invitations

pd.invitations, 3 methods.

• pd.invitations.list: List a workspace's pending invitations
• pd.invitations.revoke: Revoke an invitation
• pd.invitations.resend: Send an invitation again

knowledge

pd.knowledge, 5 methods.

• pd.knowledge.list: List a project's knowledge sources
• pd.knowledge.create: Register a knowledge source
• pd.knowledge.uploadContent: Upload a knowledge source's bytes
• pd.knowledge.reingest: Re-run ingestion for a knowledge source
• pd.knowledge.delete: Delete a knowledge source

links

pd.links, 3 methods.

• pd.links.list: Internal link suggestions for an article
• pd.links.generate: Generate internal link suggestions
• pd.links.decide: Accept, edit or reject a link suggestion

permissions

pd.permissions, 1 method.

• pd.permissions.list: The catalog of permissions a role can grant

plans

pd.plans, 5 methods.

• pd.plans.suggest: Suggest a publishing plan
• pd.plans.create: Create a publishing plan
• pd.plans.list: List publishing plans
• pd.plans.get: Read a publishing plan
• pd.plans.update: Change a publishing plan

projects

pd.projects, 16 methods.

• pd.projects.list: List a workspace's projects
• pd.projects.create: Create a project
• pd.projects.get: Read a project
• pd.projects.update: Update a project
• pd.projects.delete: Delete a project
• pd.projects.archive: Archive a project
• pd.projects.restore: Restore an archived project
• pd.projects.refreshIcon: Refetch a project's website icon
• pd.projects.listMembers: List a project's members
• pd.projects.addMember: Add a member to a project
• pd.projects.setMemberRole: Change a project member's role
• pd.projects.removeMember: Remove a member from a project
• pd.projects.detectImageStyle: Detect the project's image style from its website
• pd.projects.proposeImageStyles: Propose three image styles for the project
• pd.projects.latestImageStyleRuns: Read the project's latest image style runs
• pd.projects.applyImageStyle: Apply a detected or proposed image style

roles

pd.roles, 5 methods.

• pd.roles.list: List a workspace's roles
• pd.roles.create: Create a role
• pd.roles.update: Update a role's name, description or permissions
• pd.roles.delete: Delete a role
• pd.roles.duplicate: Duplicate a role under a new name

siteAnalyses

pd.siteAnalyses, 3 methods.

• pd.siteAnalyses.start: Analyse the client's website to draft a project
• pd.siteAnalyses.get: Read a website analysis
• pd.siteAnalyses.apply: Create the project a website analysis drafted, as reviewed

social

pd.social, 2 methods.

• pd.social.generate: Repurpose an article into social posts
• pd.social.list: The social posts stored for an article

translations

pd.translations, 2 methods.

• pd.translations.estimate: Estimate a translation
• pd.translations.create: Translate an article into another of its project's languages

usage

pd.usage, 5 methods.

• pd.usage.listTransactions: The credit ledger, newest first
• pd.usage.get: Usage records, filterable by window, project, user, operation and provider
• pd.usage.listPayments: Checkout and payment history
• pd.usage.listQuotas: Quota limits and current consumption
• pd.usage.setQuota: Set or clear a quota

webhooks

pd.webhooks, 3 methods.

• pd.webhooks.list: Webhook endpoints, recent deliveries, and the catalog of events
• pd.webhooks.create: Register a webhook endpoint
• pd.webhooks.delete: Remove a webhook endpoint

workspaces

pd.workspaces, 8 methods.

• pd.workspaces.list: List the workspaces the caller belongs to
• pd.workspaces.create: Create a workspace
• pd.workspaces.get: Read a workspace, the caller's permissions in it, and the server's features
• pd.workspaces.update: Update a workspace
• pd.workspaces.listMembers: List a workspace's members
• pd.workspaces.addMember: Add a member, or invite an address by email
• pd.workspaces.setMemberRoles: Replace a member's roles
• pd.workspaces.removeMember: Remove a member from a workspace