API Reference
Complete reference for CONCH API methods and functions
Core Methods
createConch(config)
Creates a new CONCH container with specified configuration.
const conch = await createConch({
name: string,
permissions: string[],
metadata?: object
})Returns: Promise<ConchContainer>
readConch(id)
Reads and decrypts a CONCH container by ID.
const data = await readConch(conchId: string)Returns: Promise<ConchData>
updateConch(id, data)
Updates contents of an existing CONCH container.
await updateConch(id: string, updates: object)Returns: Promise<void>
shareConch(id, agent, permissions)
Grants specific permissions to another agent.
await shareConch(
id: string,
agentId: string,
permissions: string[]
)Returns: Promise<void>
Data Types
ConchContainer
{
id: string
name: string
owner: string
created: Date
updated: Date
}ConchData
{
state: any
story: string
lineage: string[]
intent: string
}Error Handling
CONCH API methods throw specific errors for different failure conditions:
- ConchNotFound:The requested CONCH container does not exist
- PermissionDenied:The agent lacks required permissions
- ValidationError:Invalid parameters or data format
- CryptographyError:Encryption/decryption operations failed
Examples
See our Guides & Tutorials section for practical examples and common patterns.