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

# Request plugin URL

`POST /plugins/{pluginId}/url`

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.net/smokeball/apis/api.md) · [All operations](https://skmtc.net/smokeball/apis/api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/smokeball/api/revisions/197984da9b42/schema)