Associate Agent

LLM-friendly URL
POST
https://api.luzmo.com/0.1.0/agent
API call form
Examples

Associate a dataset or Rule with an Agent. Use role Securables for a dataset and linked_rules for a Rule. Only datasets can be linked through Securables ; associating a dashboard or another Securable type is rejected.

When the Agent runs, configured datasets form an allowlist and only linked Rules with a published version are applied.

Request parametersResponse schema
id UUID

The unique identifier of the entity

name OBJECT

Localized Agent name.

en STRING
description OBJECT

Localized public description of the Agent. This is display metadata and is not added to the AI prompt.

en STRING
capabilities ARRAY[STRING]

Capabilities the Agent may use. An empty array enables every capability available to the authenticated user.

value STRING
theme_id STRING

Platform theme slug or custom Theme ID used by clients to present Agent-generated assets. AIPrompt does not load or apply this theme to its response.

user_id UUID

Identifier of the user who created the Agent. This creator reference does not change when ownership is shared or reassigned.

shareable_id UUID

Identifier of the Shareable record that controls modification and ownership. Agent discovery and use remain organization-wide.

created_at DATETIME

RFC 3339 date time string indicating when the resource was created

updated_at DATETIME

RFC 3339 date time string indicating when the resource was last updated

Can be executed by:
Entity Modifier
&
Organization Editor
(For: Securables)
Entity Modifier
&
Organization Editor
(For: linked_rules)
Can be associated to:
Securables
linked_rules
User
Shareable
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.associate('agent',
  '4ae128cc-1376-4f3f-876d-09b2a841f906',
  { role: 'Securables', id: '1ecf1fd1-cf74-47f8-9f73-aed6ea6ad44a' }
);
You are not authenticated.
Log in to try
Example Response
200
400
500
Click Try it to start a request and see the response here