View as Markdown
Sanity icon

Sanity ACTION

Get Document

Get a document from a dataset in Sanity. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Sanity account once, then configure and run Get Document 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: "sanity-get-document",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    sanity: { authProvisionId: "apn_xxxxxxx" },
    dataset: "Dataset",
    documentId: "Document ID",
  },
})

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 Document inputs
Property Type Description
dataset Dataset string
The dataset to use
Required
documentId Document ID string
The document ID to use
Required Dynamic

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
sanity-get-document
Version
0.0.1
App
Sanity
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes