View as Markdown
Apify (OAuth) icon

Apify (OAuth) ACTION

Set Key-Value Store Record

Create or update a record in an Apify Key-Value Store. Supports strings, numbers, booleans, null, arrays, and objects. Automatically infers content type (JSON vs. plain text).
  • Action
  • Writes data
  • Destructive
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Apify (OAuth) account once, then configure and run Set 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-set-key-value-store-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: "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.

Set Key-Value Store Record inputs
Property Type Description
keyValueStoreId Key-Value Store ID string
The ID of the key-value store
Required Dynamic
key Key string
The key of the record to create or update.
Required
value Value any
String, number, boolean, null, array, or object. Strings that are valid JSON will be stored as JSON; otherwise as plain text.
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-set-key-value-store-record
Version
0.0.3
App
Apify (OAuth)
Authentication
OAuth
Read-only
No
Destructive
Yes
Open world
Yes