View as Markdown
Apiary icon

Apiary ACTION

Fetch Blueprint

Fetch an API Blueprint for a particular API. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Apiary account once, then configure and run Fetch Blueprint 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: "apiary-fetch-blueprint",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    apiary: { authProvisionId: "apn_xxxxxxx" },
    apiSubdomain: "API Subdomain",
  },
})

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.

Fetch Blueprint inputs
Property Type Description
apiSubdomain API Subdomain string
Subdomain of the API
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
apiary-fetch-blueprint
Version
0.0.2
App
Apiary
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes