Skip to main content

​
Revenue SDK

Revenue and share accounting.

​
Operations

MethodDescription
lucidGetAgentRevenueGet agent revenue pool status
lucidTriggerAgentAirdropTrigger revenue airdrop to share token holders
lucidGetAgentRevenueHistoryGet agent payout history

​
Generated Reference

​
Overview

​
Available Operations

​
lucidGetAgentRevenue

Retrieve the accumulated revenue pool for an agent, including total earned, pending distribution, and the share token configuration if launched.

​
Example Usage

import { RaijinLabsLucidAi } from "raijin-labs-lucid-ai";

const raijinLabsLucidAi = new RaijinLabsLucidAi();

async function run() {
  const result = await raijinLabsLucidAi.agents.revenue.lucidGetAgentRevenue({
    agentId: "<id>",
  });

  console.log(result);
}

run();

​
Standalone function

The standalone function version of this method: 
import { RaijinLabsLucidAiCore } from "raijin-labs-lucid-ai/core.js";
import { agentsRevenueLucidGetAgentRevenue } from "raijin-labs-lucid-ai/funcs/agentsRevenueLucidGetAgentRevenue.js";

// Use `RaijinLabsLucidAiCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const raijinLabsLucidAi = new RaijinLabsLucidAiCore();

async function run() {
  const res = await agentsRevenueLucidGetAgentRevenue(raijinLabsLucidAi, {
    agentId: "<id>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("agentsRevenueLucidGetAgentRevenue failed:", res.error);
  }
}

run();

​
Parameters

ParameterTypeRequiredDescription
requestoperations.LucidGetAgentRevenueRequest:heavy_check_mark:The request object to use for the request.
optionsRequestOptions:heavy_minus_sign:Used to set various options for making HTTP requests.
options.fetchOptionsRequestInit:heavy_minus_sign:Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retriesRetryConfig:heavy_minus_sign:Enables retrying HTTP requests under certain failure conditions.

​
Response

Promise<operations.LucidGetAgentRevenueResponse>

​
Errors

Error TypeStatus CodeContent Type
errors.ErrorResponse500application/json
errors.RaijinLabsLucidAiDefaultError4XX, 5XX*/*

​
lucidTriggerAgentAirdrop

Admin-only. Distributes accumulated agent revenue to share token holders proportionally based on their holdings.

​
Example Usage

import { RaijinLabsLucidAi } from "raijin-labs-lucid-ai";

const raijinLabsLucidAi = new RaijinLabsLucidAi({
  bearerAuth: process.env["RAIJINLABSLUCIDAI_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await raijinLabsLucidAi.agents.revenue.lucidTriggerAgentAirdrop({
    agentId: "<id>",
  });

  console.log(result);
}

run();

​
Standalone function

The standalone function version of this method: 
import { RaijinLabsLucidAiCore } from "raijin-labs-lucid-ai/core.js";
import { agentsRevenueLucidTriggerAgentAirdrop } from "raijin-labs-lucid-ai/funcs/agentsRevenueLucidTriggerAgentAirdrop.js";

// Use `RaijinLabsLucidAiCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const raijinLabsLucidAi = new RaijinLabsLucidAiCore({
  bearerAuth: process.env["RAIJINLABSLUCIDAI_BEARER_AUTH"] ?? "",
});

async function run() {
  const res = await agentsRevenueLucidTriggerAgentAirdrop(raijinLabsLucidAi, {
    agentId: "<id>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("agentsRevenueLucidTriggerAgentAirdrop failed:", res.error);
  }
}

run();

​
Parameters

ParameterTypeRequiredDescription
requestoperations.LucidTriggerAgentAirdropRequest:heavy_check_mark:The request object to use for the request.
optionsRequestOptions:heavy_minus_sign:Used to set various options for making HTTP requests.
options.fetchOptionsRequestInit:heavy_minus_sign:Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retriesRetryConfig:heavy_minus_sign:Enables retrying HTTP requests under certain failure conditions.

​
Response

Promise<operations.LucidTriggerAgentAirdropResponse>

​
Errors

Error TypeStatus CodeContent Type
errors.ErrorResponse400application/json
errors.ErrorResponse500application/json
errors.RaijinLabsLucidAiDefaultError4XX, 5XX*/*

​
lucidGetAgentRevenueHistory

Retrieve the complete payout history for an agent, including airdrop distributions, amounts, recipient counts, and timestamps.

​
Example Usage

import { RaijinLabsLucidAi } from "raijin-labs-lucid-ai";

const raijinLabsLucidAi = new RaijinLabsLucidAi();

async function run() {
  const result = await raijinLabsLucidAi.agents.revenue.lucidGetAgentRevenueHistory({
    agentId: "<id>",
  });

  console.log(result);
}

run();

​
Standalone function

The standalone function version of this method: 
import { RaijinLabsLucidAiCore } from "raijin-labs-lucid-ai/core.js";
import { agentsRevenueLucidGetAgentRevenueHistory } from "raijin-labs-lucid-ai/funcs/agentsRevenueLucidGetAgentRevenueHistory.js";

// Use `RaijinLabsLucidAiCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const raijinLabsLucidAi = new RaijinLabsLucidAiCore();

async function run() {
  const res = await agentsRevenueLucidGetAgentRevenueHistory(raijinLabsLucidAi, {
    agentId: "<id>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("agentsRevenueLucidGetAgentRevenueHistory failed:", res.error);
  }
}

run();

​
Parameters

ParameterTypeRequiredDescription
requestoperations.LucidGetAgentRevenueHistoryRequest:heavy_check_mark:The request object to use for the request.
optionsRequestOptions:heavy_minus_sign:Used to set various options for making HTTP requests.
options.fetchOptionsRequestInit:heavy_minus_sign:Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retriesRetryConfig:heavy_minus_sign:Enables retrying HTTP requests under certain failure conditions.

​
Response

Promise<operations.LucidGetAgentRevenueHistoryResponse>

​
Errors

Error TypeStatus CodeContent Type
errors.ErrorResponse500application/json
errors.RaijinLabsLucidAiDefaultError4XX, 5XX*/*