@soulid/registry-client

Typed SDK client for the SOUL ID Registry.

Install

npm install @soulid/registry-client

Usage

import { createClient } from '@soulid/registry-client'

const client = createClient()

// Resolve a soul_id
const soul = await client.resolve('soulid:pedro-sre:v1:001')
console.log(soul.name) // Pedro SRE

// List souls
const { items, total } = await client.list({ archetype: 'assistant', limit: 10 })

// Search
const results = await client.list({ q: 'kubernetes' })

// Publish (requires API key)
const client = createClient({ apiKey: process.env.SOULID_API_KEY })
await client.publish({
  soul_id: 'soulid:my-agent:v1:001',
  name: 'My Agent',
  archetype: 'assistant',
  purpose: 'Does useful things',
})

// Download for a specific runtime
const doc = await client.download('soulid:pedro-sre:v1:001', 'claude-code')

API

createClient(options?) → RegistryClient

| Option | Default | Description | |--------|---------|-------------| | baseUrl | https://registry.soulid.io | Registry URL | | apiKey | — | Required for publish and delete |

Methods

| Method | Description | |--------|-------------| | health() | Check registry status | | resolve(soulId) | Get a Soul Document by soul_id | | list(options?) | List souls (archetype, owner, q, limit, offset) | | publish(doc) | Create or update a Soul Document | | delete(soulId) | Remove a soul from the registry | | download(soulId, runtime) | Get soul pre-formatted for a runtime |

License

MIT