Skip to content

Call a plugin tool

POSThttps://api.vidmoat.com/v1/plugins/{slug}/{tool}
Bearer tokenScope plugins.invokeprovider-dependentTry it in the playground

Invoke an available plugin tool with its arguments. Test keys return a fixture without contacting the plugin.

Path parameters#

  • slugstringrequired
    The plugin slug.
  • toolstringrequired
    The tool name (not the namespaced MCP name).

Body#

  • argumentsobjectdefault {}
    Arguments matching the tool's input schema.
  • projectIdstring
    Passed to the plugin as context only. It grants the plugin no access to the project.

Response#

Returns 200.

Response fields#

  • okboolean
    true.
  • contentany
    What the plugin returned.
  • mediaobject or null
    When the tool produces media: { url, type }, copied into your library.

Errors#

Besides the errors any request can get (authentication, rate limits):

StatusCodeWhen
404not_foundThe plugin or tool does not exist, is not installed, or is not available to you.
400invalid_requestThe plugin returned an error, needs a paid plan, or needs you to connect (or reconnect) your account to it.
502provider_errorThe plugin timed out (20 seconds), was unreachable, redirected, returned more than 1 MB or bad JSON, or its media could not be copied.