Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.lucid.foundation/llms.txt

Use this file to discover all available pages before exploring further.

​
Anchoring SDK

DePIN anchoring control plane — query, verify, and trace artifact anchor records

​
Operations

MethodDescription
lucidListAnchorsQuery anchor records
lucidGetAnchorGet a single anchor record
lucidGetAnchorLineageGet anchor parent chain
lucidVerifyAnchorVerify anchor CID against DePIN provider
lucidLookupAnchorByCidReverse lookup anchor by CID

​
Generated Reference

​
Overview

DePIN anchoring control plane — query, verify, and trace artifact anchor records

​
Available Operations

​
lucidListAnchors

List anchor records for a given agent passport. Optionally filter by artifact type and limit results.

​
Example Usage

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

const raijinLabsLucidAi = new RaijinLabsLucidAi();

async function run() {
  const result = await raijinLabsLucidAi.anchoring.lucidListAnchors({
    agentPassportId: "<id>",
  });

  console.log(result);
}

run();

​
Standalone function

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

run();

​
Parameters

ParameterTypeRequiredDescription
requestoperations.LucidListAnchorsRequest: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.LucidListAnchorsResponse>

​
Errors

Error TypeStatus CodeContent Type
errors.ErrorResponse400, 401application/json
errors.RaijinLabsLucidAiDefaultError4XX, 5XX*/*

​
lucidGetAnchor

Retrieve a single anchor record by its unique ID.

​
Example Usage

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

const raijinLabsLucidAi = new RaijinLabsLucidAi();

async function run() {
  const result = await raijinLabsLucidAi.anchoring.lucidGetAnchor({
    anchorId: "1c20a5ef-56be-459b-b72d-bc77726c7945",
  });

  console.log(result);
}

run();

​
Standalone function

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

run();

​
Parameters

ParameterTypeRequiredDescription
requestoperations.LucidGetAnchorRequest: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.LucidGetAnchorResponse>

​
Errors

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

​
lucidGetAnchorLineage

Walk the parent_anchor_id chain for a given anchor, returning the full lineage from the target record back to the root.

​
Example Usage

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

const raijinLabsLucidAi = new RaijinLabsLucidAi();

async function run() {
  const result = await raijinLabsLucidAi.anchoring.lucidGetAnchorLineage({
    anchorId: "02ef5517-fce0-4c5f-ad6c-1783e93e4a8f",
  });

  console.log(result);
}

run();

​
Standalone function

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

run();

​
Parameters

ParameterTypeRequiredDescription
requestoperations.LucidGetAnchorLineageRequest: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.LucidGetAnchorLineageResponse>

​
Errors

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

​
lucidVerifyAnchor

Trigger verification of the anchor’s CID against its DePIN storage provider. Updates the anchor status to verified or unreachable.

​
Example Usage

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

const raijinLabsLucidAi = new RaijinLabsLucidAi();

async function run() {
  const result = await raijinLabsLucidAi.anchoring.lucidVerifyAnchor({
    anchorId: "b84b97b3-cbae-4633-b640-65cd92f9c70a",
  });

  console.log(result);
}

run();

​
Standalone function

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

run();

​
Parameters

ParameterTypeRequiredDescription
requestoperations.LucidVerifyAnchorRequest: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.LucidVerifyAnchorResponse>

​
Errors

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

​
lucidLookupAnchorByCid

Find anchor records that match a given content identifier (CID).

​
Example Usage

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

const raijinLabsLucidAi = new RaijinLabsLucidAi();

async function run() {
  const result = await raijinLabsLucidAi.anchoring.lucidLookupAnchorByCid({
    cid: "<id>",
  });

  console.log(result);
}

run();

​
Standalone function

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

run();

​
Parameters

ParameterTypeRequiredDescription
requestoperations.LucidLookupAnchorByCidRequest: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.LucidLookupAnchorByCidResponse>

​
Errors

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