Skip to main content

​
Deploy SDK

Agent deployment workflows.

​
Operations

MethodDescription
lucidDeployAgentOne-click agent deployment
lucidPreviewAgentGenerate agent code preview
lucidListAgentDeploymentsList all agent deployments
lucidGetAgentCapabilitiesList available runtime adapters and deploy targets
lucidGetAgentDeployStatusGet agent deployment status
lucidGetAgentDeployLogsGet agent deployment logs
lucidTerminateAgentTerminate a deployed agent
lucidGetDeploymentEventsGet deployment event history

​
Generated Reference

​
Overview

​
Available Operations

​
lucidDeployAgent

Admin-only. Creates a passport, generates code via runtime adapter, builds a Docker image, and deploys to the preferred target.

​
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.deploy.lucidDeployAgent({
    name: "trading-agent-v2",
    owner: "7xK9mQ2vNbPfYkRd3JhEzV1LnWqA8tUcGp4SyDfH5Bo",
    descriptor: {
      "runtime": "node",
      "framework": "langchain",
      "tools": [
        "web-search",
        "calculator",
      ],
    },
  });

  console.log(result);
}

run();

​
Standalone function

The standalone function version of this method: 
import { RaijinLabsLucidAiCore } from "raijin-labs-lucid-ai/core.js";
import { agentsDeployLucidDeployAgent } from "raijin-labs-lucid-ai/funcs/agentsDeployLucidDeployAgent.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 agentsDeployLucidDeployAgent(raijinLabsLucidAi, {
    name: "trading-agent-v2",
    owner: "7xK9mQ2vNbPfYkRd3JhEzV1LnWqA8tUcGp4SyDfH5Bo",
    descriptor: {
      "runtime": "node",
      "framework": "langchain",
      "tools": [
        "web-search",
        "calculator",
      ],
    },
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("agentsDeployLucidDeployAgent failed:", res.error);
  }
}

run();

​
Parameters

ParameterTypeRequiredDescription
requestmodels.DeployAgentRequest: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.LucidDeployAgentResponse>

​
Errors

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

​
lucidPreviewAgent

Admin-only. Generates agent code without deploying (dry run).

​
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.deploy.lucidPreviewAgent({
    descriptor: {
      "key": "<value>",
      "key1": "<value>",
      "key2": "<value>",
    },
  });

  console.log(result);
}

run();

​
Standalone function

The standalone function version of this method: 
import { RaijinLabsLucidAiCore } from "raijin-labs-lucid-ai/core.js";
import { agentsDeployLucidPreviewAgent } from "raijin-labs-lucid-ai/funcs/agentsDeployLucidPreviewAgent.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 agentsDeployLucidPreviewAgent(raijinLabsLucidAi, {
    descriptor: {
      "key": "<value>",
      "key1": "<value>",
      "key2": "<value>",
    },
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("agentsDeployLucidPreviewAgent failed:", res.error);
  }
}

run();

​
Parameters

ParameterTypeRequiredDescription
requestoperations.LucidPreviewAgentRequest: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.LucidPreviewAgentResponse>

​
Errors

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

​
lucidListAgentDeployments

Admin-only. Lists all agent deployments with optional filters.

​
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.deploy.lucidListAgentDeployments();

  console.log(result);
}

run();

​
Standalone function

The standalone function version of this method: 
import { RaijinLabsLucidAiCore } from "raijin-labs-lucid-ai/core.js";
import { agentsDeployLucidListAgentDeployments } from "raijin-labs-lucid-ai/funcs/agentsDeployLucidListAgentDeployments.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 agentsDeployLucidListAgentDeployments(raijinLabsLucidAi);
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("agentsDeployLucidListAgentDeployments failed:", res.error);
  }
}

run();

​
Parameters

ParameterTypeRequiredDescription
requestoperations.LucidListAgentDeploymentsRequest: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.LucidListAgentDeploymentsResponse>

​
Errors

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

​
lucidGetAgentCapabilities

List the available runtime adapters (node, python, langchain, crewai) and deployment targets (docker, railway, akash, phala, ionet, nosana) for agent deployment.

​
Example Usage

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

const raijinLabsLucidAi = new RaijinLabsLucidAi();

async function run() {
  const result = await raijinLabsLucidAi.agents.deploy.lucidGetAgentCapabilities();

  console.log(result);
}

run();

​
Standalone function

The standalone function version of this method: 
import { RaijinLabsLucidAiCore } from "raijin-labs-lucid-ai/core.js";
import { agentsDeployLucidGetAgentCapabilities } from "raijin-labs-lucid-ai/funcs/agentsDeployLucidGetAgentCapabilities.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 agentsDeployLucidGetAgentCapabilities(raijinLabsLucidAi);
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("agentsDeployLucidGetAgentCapabilities failed:", res.error);
  }
}

run();

​
Parameters

ParameterTypeRequiredDescription
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.LucidGetAgentCapabilitiesResponse>

​
Errors

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

​
lucidGetAgentDeployStatus

Retrieve the current deployment status for an agent by passport ID, including target platform, URL, health state, and deployment timestamps.

​
Example Usage

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

const raijinLabsLucidAi = new RaijinLabsLucidAi();

async function run() {
  const result = await raijinLabsLucidAi.agents.deploy.lucidGetAgentDeployStatus({
    passportId: "<id>",
  });

  console.log(result);
}

run();

​
Standalone function

The standalone function version of this method: 
import { RaijinLabsLucidAiCore } from "raijin-labs-lucid-ai/core.js";
import { agentsDeployLucidGetAgentDeployStatus } from "raijin-labs-lucid-ai/funcs/agentsDeployLucidGetAgentDeployStatus.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 agentsDeployLucidGetAgentDeployStatus(raijinLabsLucidAi, {
    passportId: "<id>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("agentsDeployLucidGetAgentDeployStatus failed:", res.error);
  }
}

run();

​
Parameters

ParameterTypeRequiredDescription
requestoperations.LucidGetAgentDeployStatusRequest: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.LucidGetAgentDeployStatusResponse>

​
Errors

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

​
lucidGetAgentDeployLogs

Retrieve deployment logs for an agent. Supports a tail parameter to control the number of log lines returned (default 100).

​
Example Usage

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

const raijinLabsLucidAi = new RaijinLabsLucidAi();

async function run() {
  const result = await raijinLabsLucidAi.agents.deploy.lucidGetAgentDeployLogs({
    passportId: "<id>",
  });

  console.log(result);
}

run();

​
Standalone function

The standalone function version of this method: 
import { RaijinLabsLucidAiCore } from "raijin-labs-lucid-ai/core.js";
import { agentsDeployLucidGetAgentDeployLogs } from "raijin-labs-lucid-ai/funcs/agentsDeployLucidGetAgentDeployLogs.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 agentsDeployLucidGetAgentDeployLogs(raijinLabsLucidAi, {
    passportId: "<id>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("agentsDeployLucidGetAgentDeployLogs failed:", res.error);
  }
}

run();

​
Parameters

ParameterTypeRequiredDescription
requestoperations.LucidGetAgentDeployLogsRequest: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.LucidGetAgentDeployLogsResponse>

​
Errors

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

​
lucidTerminateAgent

Admin-only. Terminates an active agent deployment.

​
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.deploy.lucidTerminateAgent({
    passportId: "<id>",
  });

  console.log(result);
}

run();

​
Standalone function

The standalone function version of this method: 
import { RaijinLabsLucidAiCore } from "raijin-labs-lucid-ai/core.js";
import { agentsDeployLucidTerminateAgent } from "raijin-labs-lucid-ai/funcs/agentsDeployLucidTerminateAgent.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 agentsDeployLucidTerminateAgent(raijinLabsLucidAi, {
    passportId: "<id>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("agentsDeployLucidTerminateAgent failed:", res.error);
  }
}

run();

​
Parameters

ParameterTypeRequiredDescription
requestoperations.LucidTerminateAgentRequest: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.LucidTerminateAgentResponse>

​
Errors

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

​
lucidGetDeploymentEvents

Returns append-only audit log of deployment lifecycle events.

​
Example Usage

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

const raijinLabsLucidAi = new RaijinLabsLucidAi();

async function run() {
  const result = await raijinLabsLucidAi.agents.deploy.lucidGetDeploymentEvents({
    passportId: "<id>",
  });

  console.log(result);
}

run();

​
Standalone function

The standalone function version of this method: 
import { RaijinLabsLucidAiCore } from "raijin-labs-lucid-ai/core.js";
import { agentsDeployLucidGetDeploymentEvents } from "raijin-labs-lucid-ai/funcs/agentsDeployLucidGetDeploymentEvents.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 agentsDeployLucidGetDeploymentEvents(raijinLabsLucidAi, {
    passportId: "<id>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("agentsDeployLucidGetDeploymentEvents failed:", res.error);
  }
}

run();

​
Parameters

ParameterTypeRequiredDescription
requestoperations.LucidGetDeploymentEventsRequest: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.LucidGetDeploymentEventsResponse>

​
Errors

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