View as Markdown
Emboss icon

Emboss ACTION

Fill Existing Form

Fill a form you previously created in Emboss, using context text and/or a context file; Emboss populates the detected fields from your context and returns the completed PDF. Create the form first with Create Fillable Form. Provide at least one context input. Polls up to ~12 minutes. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Emboss account once, then configure and run Fill Existing Form 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: "emboss-fill-existing-form",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    emboss: { authProvisionId: "apn_xxxxxxx" },
    formId: "Form ID",
    contextText: "Context (Text)",
  },
})

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.

Fill Existing Form inputs
Property Type Description
formId Form ID string
The ID of a previously created, ready Emboss form. Use the List Forms action to look up available forms, or copy the form_id returned by Create Fillable Form, e.g. 6c47f7f5-f921-4698-910f-95dd7d81310b.
Required
contextText Context (Text) string
Information to fill the form with, e.g. Applicant: Jane Doe, 38 Birchwood Court, Mooresville, IN — phone (317) 555-0126.
Optional
contextFile Context File string
A URL or /tmp path to a context document (PDF, DOCX, CSV, image, or text), e.g. /tmp/customer-data.pdf or https://example.com/invoice.pdf.
Optional
idempotencyKey Idempotency Key string
A unique string (e.g. a UUID) to safely retry this request. If a previous request with the same key already started a job, Emboss returns that original job instead of starting a new one. Scoped to your account; valid 24 hours.
Optional
callbackUrl Callback URL string
A public HTTPS URL Emboss will POST the job result to when it finishes (ready or failed), signed with X-Emboss-Signature, e.g. https://example.com/webhooks/emboss. Optional — this action already polls until the job completes.
Optional
syncDir Sync Directory dir
The File Stash directory the output PDF is written to. Defaults to /tmp.
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
emboss-fill-existing-form
Version
0.0.2
App
Emboss
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes