View as Markdown
Apiary icon

Apiary ACTION

Create API Project

Create a new API project. 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 Create API Project 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-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,
  },
})

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.

Create API Project inputs
Property Type Description
type API Type string
Type of the API
Required
public Public boolean
Defines if the API is public or private
Required
desiredName Desired Name string
If the desiredName is already taken, a different domain will be generated for your API Project. It can be later changed in the settings
Required
code Code string
FORMAT: 1
Required

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-create-api-project
Version
0.0.2
App
Apiary
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes