# Create Link — Linkly

> Create a new short link via POST /api/v1/link. See the documentation.

- Key: `linkly-create-link`
- Type: Action (Write)
- Version: 0.1.0
- App: Linkly (`linkly`) — https://pipedream.com/apps/linkly.md
- This page (HTML): https://pipedream.com/apps/linkly/actions/create-link
- Hints: open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/linkly/actions/create-link/create-link.mjs

## Description

Create a new short link via `POST /api/v1/link`. [See the documentation](https://app.linklyhq.com/swaggerui#/Links/createOrUpdateLink).

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `url` | `string` | Yes | The destination URL the short link should redirect to |
| `name` | `string` | No | Nickname for the link, shown in your Linkly dashboard |
| `domain` | `string` | No | Custom domain to use for the short URL (e.g. links.example.com). Leave empty to use the default Linkly domain. A custom slug requires a custom domain. Options are loaded from the connected account. |
| `slug` | `string` | No | Custom slug for the short URL (e.g. summer-sale). Requires a custom Domain to be set; leave empty to auto-generate. |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
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 accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_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": "linkly",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
  name: "linkly-create-link",
  arguments: {
    url: "URL",
    name: "Name",
  },
})
```

**TypeScript**

```ts
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: "linkly-create-link",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    linkly: { authProvisionId: "apn_xxxxxxx" },
    url: "URL",
    name: "Name",
  },
})

console.log(result)
```

**cURL**

```bash
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": "linkly-create-link",
    "configured_props": {
      "linkly": { "authProvisionId": "apn_xxxxxxx" },
      "url": "URL",
      "name": "Name"
    }
  }'
```

---

- App: https://pipedream.com/apps/linkly.md · All apps: https://pipedream.com/apps