CONNECT APP
Build with Apiary
Platform for API Design, Development & Documentation
Developer Tools
- API key
MCP
Give your agent Apiary tools
Every Apiary action is exposed as an MCP tool on Pipedream's remote server. Point a client at it with your end user's ID and Connect resolves that user's Apiary account for each tool call — you store no tokens.
// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "apiary",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// e.g. run Create API Project:
const result = await mcp.callTool({
name: "apiary-create-api-project",
arguments: {
type: "API Type",
public: true,
},
})# access_token: mint a short-lived token with the Connect SDK — see the MCP guide
headers = {
"Authorization": f"Bearer {access_token}",
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", # any stable ID for this user in your system
"x-pd-app-slug": "apiary",
}
async with streamablehttp_client("https://remote.mcp.pipedream.net/v3", headers=headers) as (read, write, _):
async with ClientSession(read, write) as session:
await session.initialize()
tools = await session.list_tools()
# e.g. run Create API Project:
result = await session.call_tool("apiary-create-api-project", {
"type": "API Type",
"public": True,
})API PROXY
Call the Apiary API directly
For an endpoint with no pre-built tool, the Connect proxy forwards your request to the Apiary API with the connected user's credentials attached. You store no tokens and write no refresh logic.
const resp = await pd.proxy.get({
externalUserId: "{external_user_id}", // any stable ID for this user in your system
accountId: "apn_xxxxxxx",
url: "https://api.apiary.io/me",
})
// Any allowed Apiary endpoint works here. Pipedream attaches the
// connected account's credentials to the outgoing request.# The path segment is the target URL, URL-safe base64 encoded:
# https://api.apiary.io/me
curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9hcGkuYXBpYXJ5LmlvL21l?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
-H "Authorization: Bearer {access_token}" \
-H "x-pd-environment: production"SDK
Run Apiary actions from your backend
Connect a user's Apiary account once, then run Create API Project on their behalf from your own code — TypeScript, Python, or plain HTTP.
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-create-api-project",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
apiary: { authProvisionId: "apn_xxxxxxx" },
type: "API Type",
public: true,
},
})from pipedream import Pipedream
pd = Pipedream(
client_id="{oauth_client_id}",
client_secret="{oauth_client_secret}",
project_id="{project_id}",
project_environment="production",
)
result = pd.actions.run(
id="apiary-create-api-project",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"apiary": {"authProvisionId": "apn_xxxxxxx"},
"type": "API Type",
"public": True,
},
)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "apiary-create-api-project",
"configured_props": {
"apiary": { "authProvisionId": "apn_xxxxxxx" },
"type": "API Type",
"public": true
}
}'TOOLS
Apiary actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
Create API Project
actionCreate a new API project. See the documentationWritev0.0.2 -
Fetch Blueprint
actionFetch an API Blueprint for a particular API. See the documentationWritev0.0.2 -
List API Subdomain Options
actionRetrieves available options for the API Subdomain field.Read-onlyv0.0.1 -
Publish Blueprint
actionPublish an API Blueprint for a particular API. See the documentationWritev0.0.2
No Apiary triggers are available yet.
- App slug
- apiary
- Authentication
- API key
- Categories
- Developer Tools
- Actions
- 4
- Triggers
- 0
- API proxy
- Available