View as Markdown
Affinda icon

Affinda ACTION

Upload Document for Parsing

Uploads a document for parsing. See docs here
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Affinda account once, then configure and run Upload Document for Parsing 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: "affinda-upload-document-from-url",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    affinda: { authProvisionId: "apn_xxxxxxx" },
    organization: "Organization",
    workspace: "Workspace",
  },
})

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.

Upload Document for Parsing inputs
Property Type Description
organization Organization string
The organization
Required Dynamic
workspace Workspace string
The workspace
Required Dynamic
collection Collection string
The collection
Required Dynamic
url URL string
URL to download the document.
Required
wait Wait boolean
If true, will return a response only after processing has completed. If false, will return an empty data object which can be polled at the GET endpoint until processing is complete. Defaults to true.
Optional
identifier Identifier string
Specify a custom identifier for the document.
Optional
fileName File Name string
Optional filename of the file
Optional
expiryTime Expiry Time string
The date/time in ISO-8601 format when the document will be automatically deleted. Defaults to no expiry.
Optional
language Language string
Language code in ISO 639-1 format. Must specify zh-cn or zh-tw for Chinese.
Optional
rejectDuplicates Reject Duplicates boolean
If true, parsing will fail when the uploaded document is duplicate of an existing document, no credits will be consumed. If false, will parse the document normally whether its a duplicate or not. If not provided, will fallback to the workspace settings.
Optional
regionBias Region Bias object
A JSON representation of the RegionBias object. Example: {"country": "vn"}
Optional
lowPriority Low Priority boolean
Explicitly mark this document as low priority.
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
affinda-upload-document-from-url
Version
0.0.3
App
Affinda
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes