Skip to main content

Passports SDK

AI asset identity — create, list, update, delete model/compute/tool/dataset/agent passports

Operations

Generated Reference

Overview

AI asset identity — create, list, update, delete model/compute/tool/dataset/agent passports

Available Operations

create

Register a new AI asset passport (model, compute, tool, dataset, or agent) with metadata validated against the appropriate JSON schema. Returns the created passport with its generated passport_id.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<models.CreatePassportResponse>

Errors

list

Retrieve a paginated list of passports with optional filtering by type, owner, status, and tags. Supports free-text search across name, description, and tags. Defaults to page 1, 20 results per page.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<operations.LucidListPassportsResponse>

Errors

get

Retrieve a single passport by its passport_id, including all metadata, on-chain sync status, DePIN storage CIDs, and NFT mint addresses.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<models.GetPassportResponse>

Errors

update

Update mutable fields on an existing passport (metadata, name, description, version, tags, status). Requires the X-Owner-Address header for ownership verification if configured.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<models.GetPassportResponse>

Errors

delete

Soft-delete a passport by setting its status to revoked. The passport record is retained for audit purposes. Requires X-Owner-Address header for ownership verification.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<operations.LucidDeletePassportResponse>

Errors

sync

Initiate an on-chain sync for a passport, writing its metadata hash to the Solana lucid_passports program. Returns the PDA address and transaction signature on success.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<operations.LucidTriggerPassportSyncResponse>

Errors

listPendingSync

List all passports that have been created or updated off-chain but not yet synced to on-chain state. Useful for monitoring the sync backlog.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<operations.LucidListPassportsPendingSyncResponse>

Errors

getStats

Retrieve aggregate statistics about passports including counts by type, status breakdown, and sync status. No authentication required.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<models.PassportStatsResponse>

Errors

searchModels

Search model passports with ModelMeta-specific filters including runtime, format, max VRAM, and availability. The availability filter is tri-state: ‘true’ for models with healthy compute, ‘false’ for unavailable models, omit for all.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<operations.LucidSearchModelsResponse>

Errors

lucidListTools

List active tool passports with optional filtering by owner, tags, and free-text search. Returns paginated results sorted by creation date.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<operations.LucidListToolsResponse>

Errors

lucidListDatasets

List active dataset passports with optional filtering by owner, tags, and free-text search. Returns paginated results sorted by creation date.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<operations.LucidListDatasetsResponse>

Errors

lucidListAgentPassports

List active agent passports with optional filtering by owner, tags, and free-text search. Returns paginated results sorted by creation date.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<operations.LucidListAgentPassportsResponse>

Errors

lucidUpdatePassportPricing

Update pricing-related fields on a passport (e.g., price per token, pricing model). Requires X-Owner-Address header for ownership verification.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<models.GetPassportResponse>

Errors

lucidRetryPassportProjections

Triggers a retry of identity projection to all configured external registries (Metaplex, QuantuLabs) for a passport. Useful when projections are stuck in ‘failed’ or ‘pending’ status. Runs asynchronously — returns immediately with current projection status.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<operations.LucidRetryPassportProjectionsResponse>

Errors

lucidUpdatePassportEndpoints

Update the endpoint URLs on a passport (inference URL, health URL, metrics URL). Requires X-Owner-Address header for ownership verification.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<models.GetPassportResponse>

Errors