View as Markdown
ChatPDF icon

ChatPDF ACTION

Chat With PDF

Sends messages to interact with a specific PDF using its source ID. Can handle single or multiple messages for complex queries. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's ChatPDF account once, then configure and run Chat With PDF 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: "chatpdf-chat-with-pdf",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    chatpdf: { authProvisionId: "apn_xxxxxxx" },
    sourceId: "Source ID",
    messages: ["Messages"],
  },
})

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.

Chat With PDF inputs
Property Type Description
sourceId Source ID string
The source ID of the PDF in chatpdf
Required
messages Messages string[]
An array of messages to interact with the PDF. Each row should be set as a JSON string. Eg: {"role": "user", "content": "How much is the world?"}, {"role": "assistant", "content": "The world is 10 dollars."} and {"role": "user", "content": "Where can I buy it?"}
Required
referenceSources Reference Sources boolean
Includes references to the PDF pages that were used to generate the response.
Optional

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
chatpdf-chat-with-pdf
Version
0.0.3
App
ChatPDF
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes