CONNECT APP
Build with Mintlify
Web & App Development
- API key
MCP
Give your agent Mintlify tools
Every Mintlify 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 Mintlify 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": "mintlify",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// e.g. run Chat with Assistant:
const result = await mcp.callTool({
name: "mintlify-chat-with-assistant",
arguments: {
domain: "Domain",
fp: "FP",
},
})# 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": "mintlify",
}
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 Chat with Assistant:
result = await session.call_tool("mintlify-chat-with-assistant", {
"domain": "Domain",
"fp": "FP",
})API PROXY
Call the Mintlify API directly
For an endpoint with no pre-built tool, the Connect proxy forwards your request to the Mintlify 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.example.com/v1/me",
})
// Any allowed Mintlify 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.example.com/v1/me
curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9hcGkuZXhhbXBsZS5jb20vdjEvbWU?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
-H "Authorization: Bearer {access_token}" \
-H "x-pd-environment: production"SDK
Run Mintlify actions from your backend
Connect a user's Mintlify account once, then run Chat with Assistant 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: "mintlify-chat-with-assistant",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
mintlify: { authProvisionId: "apn_xxxxxxx" },
domain: "Domain",
fp: "FP",
},
})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="mintlify-chat-with-assistant",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"mintlify": {"authProvisionId": "apn_xxxxxxx"},
"domain": "Domain",
"fp": "FP",
},
)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": "mintlify-chat-with-assistant",
"configured_props": {
"mintlify": { "authProvisionId": "apn_xxxxxxx" },
"domain": "Domain",
"fp": "FP"
}
}'TOOLS
Mintlify actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
Chat with Assistant
actionGenerates a response message from the assistant for the specified domain. See the documentationRead-onlyv0.0.1 -
Search Documentation
actionPerform semantic and keyword searches across your documentation. See the documentationRead-onlyv0.0.1 -
Trigger Update
actionTrigger an update for a project. See the documentationWritev0.0.1
EVENTS
Mintlify triggers
Event sources your backend can deploy for users and receive through a webhook.
No Mintlify triggers are available yet.
MULTI-APP
Use Mintlify with other popular apps
Most products don't stop at one integration. Pair Mintlify with the other apps your users rely on, and ship use cases that span both.
- App slug
- mintlify
- Authentication
- API key
- Categories
- Web & App Development
- Actions
- 3
- Triggers
- 0
- API proxy
- Available