View as Markdown
AskYourPDF icon

AskYourPDF ACTION

Chat With Document

Chat with a document. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's AskYourPDF account once, then configure and run Chat With Document 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: "askyourpdf-chat-with-document",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    askyourpdf: { authProvisionId: "apn_xxxxxxx" },
    docId: "Document ID",
    sender: "Sender",
  },
})

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 Document inputs
Property Type Description
docId Document ID string
The ID of the document for the conversation.
Required
sender Sender string
The sender of the chat message. The sender should be user.
Required
message Message string
The chat message content.
Required
stream Stream boolean
Flag for streaming. Default is false
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
askyourpdf-chat-with-document
Version
0.0.5
App
AskYourPDF
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes