Enable org plugin for namespace

Enable an org-level plugin for this namespace.

This:

1. Adds the plugin to the namespace’s feature_extractors array
2. Optionally deploys the plugin to Ray (if deploy=True)

After enabling, the plugin can be used when creating collections in this namespace.

Note: The plugin must exist at the organization level (uploaded via POST /v1/plugins/uploads).

POST /v1/namespaces/{namespace_id}/plugins/org/{plugin_id}/enable

Enable org plugin for namespace

cURL

curl --request POST \
  --url https://api.mixpeek.com/v1/namespaces/{namespace_id}/plugins/org/{plugin_id}/enable \
  --header 'Content-Type: application/json' \
  --data '
{
  "params": {},
  "deploy": true
}
'

200

{
  "success": true,
  "plugin_id": "my_plugin_1_0_0",
  "namespace_id": "ns_xxx",
  "feature_uri": "mixpeek://my_plugin@1.0.0",
  "message": "Plugin my_plugin@1.0.0 enabled for namespace",
  "deployment_status": "deployed"
}

Headers

Authorization · string

REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

Examples:

"Bearer YOUR_API_KEY"

"Bearer YOUR_STRIPE_API_KEY"

Path Parameters

namespace_id · string · required

plugin_id · string · required

Body

application/json

Request to enable an org-level plugin for a namespace.

This adds the plugin to the namespace's feature_extractors array, making it available for use in collections within this namespace.

params · Params · object

Optional parameters to configure the plugin for this namespace

deploy · boolean · default: true

Whether to deploy the plugin to Ray immediately after enabling

Response

200

application/json

Plugin enabled successfully

Response from enabling an org-level plugin for a namespace.

success · boolean · required

Whether the operation succeeded

plugin_id · string · required

The plugin ID that was enabled

namespace_id · string · required

The namespace where plugin was enabled

feature_uri · string · required

Feature URI to use in collections

message · string · required

Status message

deployment_status · enum<string> | null

Deployment status if deploy=True

Available options: deployed, pending, skipped