View as Markdown
Readwise icon

Readwise ACTION

Get Highlight Details

Get Highlight´s Details See the docs here
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Readwise account once, then configure and run Get Highlight Details 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: "readwise-get-highlight-details",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    readwise: { authProvisionId: "apn_xxxxxxx" },
    bookId: 10,
    highlightId: 10,
  },
})

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 Highlight Details inputs
Property Type Description
bookId Book Id integer
Id of the book to list highlights
Required Dynamic
highlightId Highlight Id integer
Id of the highlight to list details
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
readwise-get-highlight-details
Version
0.0.4
App
Readwise
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes