---
title: "Request plugin URL"
method: POST
path: "/plugins/{pluginId}/url"
tags: ["Plugins"]
---

# Request plugin URL

`POST /plugins/{pluginId}/url`

## Request

- Base URL: `https://api.smokeball.com`
- URL: `https://api.smokeball.com/plugins/{pluginId}/url`
- Auth: API key in header `x-api-key` and API key in header `Authorization`

Requests a secure URL from the plugin's endpoint for invoking the plugin.
Accepts additional key/value pairs to pass to the plugin endpoint.
Reserved keys (AccountId, UserId, UserEmail, MatterId, AppId, EmbedToken) cannot be included in AdditionalData.

## Path parameters

- `pluginId` string, uuid, required

## Request body

- PluginUrlRequestDto
  - `matterId` string, nullable: The matter id associated with the request, if applicable.
  - `additionalData` object, nullable: Additional key/value pairs to pass to the plugin endpoint. Reserved keys (AccountId, UserId, UserEmail, MatterId) will be rejected.

## Response `200`

When request is successful. Returns the plugin URL.

- string

## Other responses

- `400`: When plugin does not return a valid URL or reserved keys are used.
- `401`: When request is not authenticated with client credentials.
- `403`: Forbidden
- `404`: When plugin with specified id does not exist.

---

[API](https://skmtc.dev/smokeball/apis/smokeball-api.md) - [All operations](https://skmtc.dev/smokeball/apis/smokeball-api/llms.txt) - [OpenAPI document](https://skmtc.dev/smokeball/apis/smokeball-api/revisions/6e350cf667d4?raw)