View as Markdown
Nyckel icon

Nyckel ACTION

Extract Text from Image

Extracts text from an image URL. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Nyckel account once, then configure and run Extract Text from Image 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: "nyckel-extract-text-from-image",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    nyckel: { authProvisionId: "apn_xxxxxxx" },
    functionId: "Function ID",
    imageOrUrl: "File Path or URL",
  },
})

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.

Extract Text from Image inputs
Property Type Description
functionId Function ID string
Select a function or provide a custom function ID.
Required Dynamic
imageOrUrl File Path or URL string
An image file. Provide either a file URL or a path to a file in the /tmp directory (for example, /tmp/myFile.jpg)
Required
includeRegions Include Regions boolean
When set to true, return the regions of the image that contained text
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
nyckel-extract-text-from-image
Version
0.1.1
App
Nyckel
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes