raijin-labs-lucid-ai
v0.4.1
Published
Developer-friendly & type-safe Typescript SDK specifically catered to leverage *raijin-labs-lucid-ai* API.
Readme
raijin-labs-lucid-ai
Developer-friendly & type-safe Typescript SDK specifically catered to leverage raijin-labs-lucid-ai API.
[!IMPORTANT] This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.
Summary
LucidLayer API: LucidLayer Offchain API.
This OpenAPI spec is the source of truth for the actual backend routes. It is used to generate SDK clients via Speakeasy.
Route groups:
/v1/*— Passports, Match, Run, Receipts, Epochs, Payouts, Compute/health/*— System health and dependency checks/api/agents/*— AI Agent MMR, Planner, and Orchestrator
Table of Contents
SDK Installation
[!TIP] To finish publishing your SDK to npm and others you must run your first generation action.
The SDK can be installed with either npm, pnpm, bun or yarn package managers.
NPM
npm add <UNSET>PNPM
pnpm add <UNSET>Bun
bun add <UNSET>Yarn
yarn add <UNSET>[!NOTE] This package is published with CommonJS and ES Modules (ESM) support.
Requirements
For supported JavaScript runtimes, please consult RUNTIMES.md.
SDK Example Usage
Example
import { RaijinLabsLucidAi } from "raijin-labs-lucid-ai";
const raijinLabsLucidAi = new RaijinLabsLucidAi();
async function run() {
const result = await raijinLabsLucidAi.passports.create({
type: "dataset",
owner: "<value>",
metadata: {
"key": "<value>",
"key1": "<value>",
"key2": "<value>",
},
});
console.log(result);
}
run();
Available Resources and Operations
Agents
- initAgent - Initialize an AI agent
- processAgentEpoch - Process an epoch for an agent
- processAgentBatchEpochs - Process multiple epochs in batch
- generateAgentProof - Generate proof of contribution
- getAgentStats - Get agent statistics
- getAgentHistory - Get agent MMR root history
- getAgentRoot - Get current MMR root for agent
- verifyAgentMmr - Verify MMR integrity for agent
- listAgents - List all registered agents
- planAgentWorkflow - Plan a workflow from a goal
- accomplishAgentGoal - Plan and execute a workflow in one call
- previewAgentWorkflow - Preview a workflow without executing
- getAgentOrchestratorHistory - Get agent execution history for a tenant
- checkAgentOrchestratorHealth - Agent orchestrator health check
- executeAgentFlowspec - Execute a FlowSpec
- validateFlowspec - Validate a FlowSpec structure
- getPlannerInfo - Get planner service info
- checkExecutorHealth - Check executor health
- getExecutorDecision - Get executor decision for a FlowSpec
Compute
- searchCompute - Search compute passports
- heartbeat - Submit compute node heartbeat
- getNodeHealth - Get compute node health
Epochs
- getCurrent - Get current epoch
- list - List epochs
- create - Create epoch
- get - Get epoch
- retry - Retry failed epoch
- verify - Verify epoch anchor
- getTransaction - Get epoch anchoring transaction
- commitRoot - Commit epoch root
- commitRootsBatch - Commit multiple epoch roots
- getAnchoringHealth - Anchoring service health
- listReady - Get epochs ready for finalization
- getStats - Epoch statistics
Health
- checkSystemHealth - Overall system health
- checkLiveness - Liveness probe
- checkReadiness - Readiness probe
- checkDatabaseHealth - Database health check
- checkRedisHealth - Redis health check
- checkNangoHealth - Nango service health check
- getDetailedHealth - Detailed health with statistics
Match
- explain - Evaluate policy against compute/model meta
- compute - Match compute for model
- planRoute - Plan a route (match + resolve endpoint)
Passports
- create - Create a passport
- list - List passports
- get - Get a passport
- update - Update a passport
- delete - Delete a passport (soft delete)
- sync - Trigger on-chain sync for a passport
- listPendingSync - Get passports pending sync
- getStats - Passport statistics
- searchModels - Search model passports
- lucidListTools - List tool passports
- lucidListDatasets - List dataset passports
- lucidListAgentPassports - List agent passports
Payouts
- calculate - Calculate payout split
- createFromReceipt - Create payout from receipt token data
- get - Get payout by run_id
- verify - Verify payout split
Receipts
- create - Create a receipt
- get - Get a receipt
- verify - Verify a receipt (hash + signature + inclusion)
- getProof - Get inclusion proof for receipt
- lucidVerifyReceiptByHash - Verify receipt by hash with inclusion proof and epoch info
- getMmrRoot - Get current MMR root
- getSignerPubKey - Get orchestrator signing public key
Run
- inference - Run inference (optionally streaming via SSE)
- chatCompletions - OpenAI-compatible chat completions
Standalone functions
All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.
To read more about standalone functions, check FUNCTIONS.md.
agentsAccomplishAgentGoal- Plan and execute a workflow in one callagentsCheckAgentOrchestratorHealth- Agent orchestrator health checkagentsCheckExecutorHealth- Check executor healthagentsExecuteAgentFlowspec- Execute a FlowSpecagentsGenerateAgentProof- Generate proof of contributionagentsGetAgentHistory- Get agent MMR root historyagentsGetAgentOrchestratorHistory- Get agent execution history for a tenantagentsGetAgentRoot- Get current MMR root for agentagentsGetAgentStats- Get agent statisticsagentsGetExecutorDecision- Get executor decision for a FlowSpecagentsGetPlannerInfo- Get planner service infoagentsInitAgent- Initialize an AI agentagentsListAgents- List all registered agentsagentsPlanAgentWorkflow- Plan a workflow from a goalagentsPreviewAgentWorkflow- Preview a workflow without executingagentsProcessAgentBatchEpochs- Process multiple epochs in batchagentsProcessAgentEpoch- Process an epoch for an agentagentsValidateFlowspec- Validate a FlowSpec structureagentsVerifyAgentMmr- Verify MMR integrity for agentcomputeGetNodeHealth- Get compute node healthcomputeHeartbeat- Submit compute node heartbeatcomputeSearchCompute- Search compute passportsepochsCommitRoot- Commit epoch rootepochsCommitRootsBatch- Commit multiple epoch rootsepochsCreate- Create epochepochsGet- Get epochepochsGetAnchoringHealth- Anchoring service healthepochsGetCurrent- Get current epochepochsGetStats- Epoch statisticsepochsGetTransaction- Get epoch anchoring transactionepochsList- List epochsepochsListReady- Get epochs ready for finalizationepochsRetry- Retry failed epochepochsVerify- Verify epoch anchorhealthCheckDatabaseHealth- Database health checkhealthCheckLiveness- Liveness probehealthCheckNangoHealth- Nango service health checkhealthCheckReadiness- Readiness probehealthCheckRedisHealth- Redis health checkhealthCheckSystemHealth- Overall system healthhealthGetDetailedHealth- Detailed health with statisticsmatchCompute- Match compute for modelmatchExplain- Evaluate policy against compute/model metamatchPlanRoute- Plan a route (match + resolve endpoint)passportsCreate- Create a passportpassportsDelete- Delete a passport (soft delete)passportsGet- Get a passportpassportsGetStats- Passport statisticspassportsList- List passportspassportsListPendingSync- Get passports pending syncpassportsLucidListAgentPassports- List agent passportspassportsLucidListDatasets- List dataset passportspassportsLucidListTools- List tool passportspassportsSearchModels- Search model passportspassportsSync- Trigger on-chain sync for a passportpassportsUpdate- Update a passportpayoutsCalculate- Calculate payout splitpayoutsCreateFromReceipt- Create payout from receipt token datapayoutsGet- Get payout by run_idpayoutsVerify- Verify payout splitreceiptsCreate- Create a receiptreceiptsGet- Get a receiptreceiptsGetMmrRoot- Get current MMR rootreceiptsGetProof- Get inclusion proof for receiptreceiptsGetSignerPubKey- Get orchestrator signing public keyreceiptsLucidVerifyReceiptByHash- Verify receipt by hash with inclusion proof and epoch inforeceiptsVerify- Verify a receipt (hash + signature + inclusion)runChatCompletions- OpenAI-compatible chat completionsrunInference- Run inference (optionally streaming via SSE)
Retries
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
import { RaijinLabsLucidAi } from "raijin-labs-lucid-ai";
const raijinLabsLucidAi = new RaijinLabsLucidAi();
async function run() {
const result = await raijinLabsLucidAi.passports.create({
type: "dataset",
owner: "<value>",
metadata: {
"key": "<value>",
"key1": "<value>",
"key2": "<value>",
},
}, {
retries: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
});
console.log(result);
}
run();
If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
import { RaijinLabsLucidAi } from "raijin-labs-lucid-ai";
const raijinLabsLucidAi = new RaijinLabsLucidAi({
retryConfig: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
});
async function run() {
const result = await raijinLabsLucidAi.passports.create({
type: "dataset",
owner: "<value>",
metadata: {
"key": "<value>",
"key1": "<value>",
"key2": "<value>",
},
});
console.log(result);
}
run();
Error Handling
RaijinLabsLucidAiError is the base class for all HTTP error responses. It has the following properties:
| Property | Type | Description |
| ------------------- | ---------- | --------------------------------------------------------------------------------------- |
| error.message | string | Error message |
| error.statusCode | number | HTTP response status code eg 404 |
| error.headers | Headers | HTTP response headers |
| error.body | string | HTTP body. Can be empty string if no body is returned. |
| error.rawResponse | Response | Raw HTTP response |
| error.data$ | | Optional. Some errors may contain structured data. See Error Classes. |
Example
import { RaijinLabsLucidAi } from "raijin-labs-lucid-ai";
import * as errors from "raijin-labs-lucid-ai/models/errors";
const raijinLabsLucidAi = new RaijinLabsLucidAi();
async function run() {
try {
const result = await raijinLabsLucidAi.passports.create({
type: "dataset",
owner: "<value>",
metadata: {
"key": "<value>",
"key1": "<value>",
"key2": "<value>",
},
});
console.log(result);
} catch (error) {
// The base class for HTTP error responses
if (error instanceof errors.RaijinLabsLucidAiError) {
console.log(error.message);
console.log(error.statusCode);
console.log(error.body);
console.log(error.headers);
// Depending on the method different errors may be thrown
if (error instanceof errors.ErrorResponse) {
console.log(error.data$.success); // boolean
console.log(error.data$.error); // string
console.log(error.data$.message); // string
console.log(error.data$.errorCode); // string
console.log(error.data$.details); // any
}
}
}
}
run();
Error Classes
Primary errors:
RaijinLabsLucidAiError: The base class for HTTP error responses.ErrorResponse: Bad Request. *
Network errors:
ConnectionError: HTTP client was unable to make a request to a server.RequestTimeoutError: HTTP request timed out due to an AbortSignal signal.RequestAbortedError: HTTP request was aborted by the client.InvalidRequestError: Any input used to create a request is invalid.UnexpectedClientError: Unrecognised or unexpected error.
Inherit from RaijinLabsLucidAiError:
HealthCheckResultError: Healthy. Status code503. Applicable to 3 of 69 methods.*SystemHealthError: Healthy. Status code503. Applicable to 1 of 69 methods.*ServiceUnavailableError: Not ready. Status code503. Applicable to 1 of 69 methods.*ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. Seeerror.rawValuefor the raw value anderror.pretty()for a nicely formatted multi-line string.
* Check the method documentation to see if the error is applicable.
Server Selection
Override Server URL Per-Client
The default server can be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:
import { RaijinLabsLucidAi } from "raijin-labs-lucid-ai";
const raijinLabsLucidAi = new RaijinLabsLucidAi({
serverURL: "https://api.lucid.foundation",
});
async function run() {
const result = await raijinLabsLucidAi.passports.create({
type: "dataset",
owner: "<value>",
metadata: {
"key": "<value>",
"key1": "<value>",
"key2": "<value>",
},
});
console.log(result);
}
run();
Custom HTTP Client
The TypeScript SDK makes API calls using an HTTPClient that wraps the native
Fetch API. This
client is a thin wrapper around fetch and provides the ability to attach hooks
around the request lifecycle that can be used to modify the request or handle
errors and response.
The HTTPClient constructor takes an optional fetcher argument that can be
used to integrate a third-party HTTP client or when writing tests to mock out
the HTTP client and feed in fixtures.
The following example shows how to use the "beforeRequest" hook to to add a
custom header and a timeout to requests and how to use the "requestError" hook
to log errors:
import { RaijinLabsLucidAi } from "raijin-labs-lucid-ai";
import { HTTPClient } from "raijin-labs-lucid-ai/lib/http";
const httpClient = new HTTPClient({
// fetcher takes a function that has the same signature as native `fetch`.
fetcher: (request) => {
return fetch(request);
}
});
httpClient.addHook("beforeRequest", (request) => {
const nextRequest = new Request(request, {
signal: request.signal || AbortSignal.timeout(5000)
});
nextRequest.headers.set("x-custom-header", "custom value");
return nextRequest;
});
httpClient.addHook("requestError", (error, request) => {
console.group("Request Error");
console.log("Reason:", `${error}`);
console.log("Endpoint:", `${request.method} ${request.url}`);
console.groupEnd();
});
const sdk = new RaijinLabsLucidAi({ httpClient: httpClient });Debugging
You can setup your SDK to emit debug logs for SDK requests and responses.
You can pass a logger that matches console's interface as an SDK option.
[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
import { RaijinLabsLucidAi } from "raijin-labs-lucid-ai";
const sdk = new RaijinLabsLucidAi({ debugLogger: console });You can also enable a default debug logger by setting an environment variable RAIJINLABSLUCIDAI_DEBUG to true.
Development
Maturity
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
Contributions
While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.
