Create Plugin

LLM-friendly URL
POST
https://api.luzmo.com/0.1.0/plugin

Plugins are flexible data connectors to connect data stores, APIs or open datasets to Luzmo.

If a built-in Luzmo connector is not yet available for your database or service, or if you already have an API for your company data and want to reuse it, building a plugin is the way to go!

  • Building plugins: more information about developing Plugins can be found in the Plugin API chapter.

  • Registering plugins: once your plugin is built, you can register it either via the Luzmo UI or use the Core API to automatically register a plugin for your user.

Your base URL should not end with / . The endpoints that will be called are: BASE_URL/datasets , BASE_URL/query , etc.

When you build a plugin, you essentially host an API with authentication and several standard endpoints. The create action in the Core API registers the plugin in the platform for a specific user. You can then later associate it to an organization in order to make it available for the organization.

The effect will be that users of your organization will see this plugin when they add new data.

Parameters
Expand all Reset
properties *OBJECTrequired
slug *STRINGrequired
name *Multilingual stringrequired
description Multilingual string
base_url *STRINGrequired
pushdown BOOLEAN
authorize *ENUMrequired
properties ARRAY[OBJECT]
protocol_version ENUM
search BOOLEAN
supports_distinctcount BOOLEAN
supports_order_limit BOOLEAN
supports_join BOOLEAN
supports_like BOOLEAN
supports_nested_filters BOOLEAN
supports_sql BOOLEAN
tiles BOOLEAN
color STRING
url STRING
license STRING
public BOOLEAN
Can be executed by:
Logged-in User
Can be associated to:
Organization
Thumbnail
User
Dissociate Organization
Search Plugin
Did this page help you?
Yes No
Language
Shell
Node
Java
.NET
Python
PHP
Install
npm install @luzmo/nodejs-sdk
Example Request 
import Luzmo from '@luzmo/nodejs-sdk';
const client = new Luzmo({
  api_key: '<your Luzmo API key>',
  api_token: '<your Luzmo API token>',
  host: 'https://api.luzmo.com'
});


const response = await client.create('plugin',
  {
    slug: "myplugin",
    name: {
      en: "My Internal Api Plugin"
    },
    description: {
      en: "Since we already have an API, we wrote a simple plugin around our API"
    },
    base_url: "https://my-company.com/data/api/v1",
    url: "https://my-company.com/info",
    color: "#00FF00",
    pushdown: false,
    authorize: "custom",
    properties: [
      
      {
        id: "api_key",
        name: {
          en: "API key"
        },
        sensitive: false
      },
      
      {
        id: "api_token",
        name: {
          en: "API token"
        },
        sensitive: true
      }
    ]
  }
);
You are not authenticated.
Log in to try
Example Response
200
400
500
{
  "id": "6b297528-91e5-4655-99a3-fe200f91b64b",
  "slug": "myplugin9974880",
  "name": {
    "en": "My Internal Api Plugin"
  },
  "description": {
    "en": "Since we already have an API, we wrote a simple plugin around our API"
  },
  "url": "https://url-to-some-product-info.com",
  "license": "Create Commons 0",
  "base_url": "https://8017349d.ngrok.io",
  "authorize": "token",
  "tiles": true,
  "search": false,
  "public": false,
  "reviewed": false,
  "color": "#00FF00"
}