View as Markdown
Apify (OAuth) icon

Apify (OAuth) ACTION

Get Key-Value Store Record

Gets a record from a key-value store. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Apify (OAuth) account once, then configure and run Get Key-Value Store Record 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: "apify_oauth-get-kvs-record",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    apify_oauth: { authProvisionId: "apn_xxxxxxx" },
    keyValueStoreId: "Key-Value Store ID",
    key: "Record Key",
  },
})

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.

Get Key-Value Store Record inputs
Property Type Description
keyValueStoreId Key-Value Store ID string
The ID of the key-value store
Required Dynamic
key Record Key string
If the record is a valid JSON object, the output will include all parsed attributes as individual fields. If the record is any other file type (such as PDFs, images, or plain text), the output will instead be a file reference.
Required

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
apify_oauth-get-kvs-record
Version
0.0.1
App
Apify (OAuth)
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes