Definitions
CRUD operations for agent, command, workflow, and pipeline definitions. Create drafts, publish, deprecate, and search.
8 methods
client.definitions.list()
List definitions with optional filters and pagination. Supports full-text search, type filtering, and tag-based queries.
ParametersListDefinitionsQuery
typeoptionalstringFilter by definition type.
agentcommandworkflowpipelinestatusoptionalstringFilter by status.
draftpublisheddeprecatedarchivedagentTypeoptionalstringFilter by agent subtype (agents only).
validatorexecutoranalystgeneratorexplorerforecasterdomainoptionalstringFilter by domain.
softwaresecuritycompliancelegalmedicalfinancialscientificcontentgeneralcognitive-lenstieroptionalstringFilter by tier.
usercommunityprovisibilityoptionalstringFilter by visibility.
privateunlistedpublicauthorIdoptionalstringuuidFilter by author user ID.
searchoptionalstringFull-text search on name and description.
tagoptionalstring | string[]Filter by tag(s).
limitoptionalnumberResults per page.
Default:20offsetoptionalnumberPagination offset.
Default:0sortByoptionalstringSort field.
namecreatedAtupdatedAtexecutionCountsortOrderoptionalstringSort direction.
ascdescReturn Fields
definitionsrequiredDefinitionListItem[]Array of definition summaries.
totalrequirednumberTotal matching definitions.
limitrequirednumberPage size used.
offsetrequirednumberOffset used.
hasMoreoptionalbooleanWhether more results exist beyond this page.
list(query?: ListDefinitionsQuery): Promise<DefinitionListResponse>import { RegistryClient } from '@uluops/registry-sdk';
const client = new RegistryClient({
apiKey: 'ulr_your-api-key',
});
const result = await client.definitions.list();
console.log(result.definitions);// Promise<DefinitionListResponse>
{
definitions: DefinitionListItem[];
total: number;
limit: number;
offset: number;
hasMore?: boolean;
}client.definitions.get()
Get a single definition by type and name. Returns the latest published version if no version specified.
Parameters
typerequiredstringDefinition type.
agentcommandworkflowpipelinenamerequiredstringDefinition name.
versionoptionalstringSemantic version. If omitted, returns latest published.
includeRuntimeoptionalbooleanInclude rendered markdown in response.
includeYamloptionalbooleanInclude full YAML content.
includeRefsoptionalbooleanInclude cross-references (dependencies, forks).
Return Fields
idrequiredstringuuidDefinition UUID.
typerequiredstringDefinition type.
namerequiredstringDefinition name.
versionrequiredstringSemantic version.
statusrequiredstringCurrent status (draft, published, deprecated).
yamloptionalstringFull YAML content (if requested).
runtimeMdoptionalstringRendered markdown (if requested).
get(type: DefinitionType, name: string, version?: string, options?: GetDefinitionOptions): Promise<Definition>import { RegistryClient } from '@uluops/registry-sdk';
const client = new RegistryClient({
apiKey: 'ulr_your-api-key',
});
const result = await client.definitions.get('agent', 'my-project');
console.log(result.id);// Promise<Definition>
{
id: string;
type: string;
name: string;
version: string;
status: string;
yaml?: string;
runtimeMd?: string;
}client.definitions.create()
Create a new draft definition. The definition starts in draft status and must be published separately.
Parameters
typerequiredstringDefinition type.
agentcommandworkflowpipelinenamerequiredstringDefinition name (alphanumeric and hyphens).
yamlrequiredstringYAML content (max 100KB).
visibilityoptionalstringVisibility level.
privateunlistedpublicprivatecreate(type: DefinitionType, name: string, body: CreateDefinitionBody): Promise<Definition>import { RegistryClient } from '@uluops/registry-sdk';
const client = new RegistryClient({
apiKey: 'ulr_your-api-key',
});
const result = await client.definitions.create(
'agent',
'my-project',
'name: example-agent\nversion: 1.0.0'
);Promise<Definition>client.definitions.update()
Update a draft definition. Published definitions are immutable and cannot be edited.
ParametersUpdateDefinitionBody
typerequiredstringDefinition type.
agentcommandworkflowpipelinenamerequiredstringDefinition name.
versionrequiredstringDefinition version.
yamloptionalstringUpdated YAML content (max 100KB).
visibilityoptionalstringVisibility level.
privateunlistedpublicdisplayNameoptionalstringHuman-readable display name.
descriptionoptionalstringLong description.
domainoptionalstringDomain category.
softwaresecuritycompliancelegalmedicalfinancialscientificcontentgeneralcognitive-lensagentTypeoptionalstringAgent subtype (agents only).
validatorexecutoranalystgeneratorexplorerforecastertagsoptionalstring[]Tags for categorization.
changeSummaryoptionalstringSummary of changes made.
changeTypeoptionalstringChange magnitude.
majorminorpatchupdate(type: DefinitionType, name: string, version: string, body: UpdateDefinitionBody): Promise<Definition>import { RegistryClient } from '@uluops/registry-sdk';
const client = new RegistryClient({
apiKey: 'ulr_your-api-key',
});
const result = await client.definitions.update({
type: 'agent',
name: 'my-project',
version: '1.0.0',
});Promise<Definition>client.definitions.delete()
Delete a draft definition. Published definitions cannot be deleted — deprecate them instead.
Parameters
typerequiredstringDefinition type.
agentcommandworkflowpipelinenamerequiredstringDefinition name.
versionrequiredstringDefinition version.
delete(type: DefinitionType, name: string, version: string): Promise<void>import { RegistryClient } from '@uluops/registry-sdk';
const client = new RegistryClient({
apiKey: 'ulr_your-api-key',
});
const result = await client.definitions.delete('agent', 'my-project', '1.0.0');Promise<void>client.definitions.publish()
Publish a draft definition. Transitions status to published and makes the definition immutable.
Parameters
typerequiredstringDefinition type.
agentcommandworkflowpipelinenamerequiredstringDefinition name.
versionrequiredstringDefinition version.
publish(type: DefinitionType, name: string, version: string): Promise<Definition>import { RegistryClient } from '@uluops/registry-sdk';
const client = new RegistryClient({
apiKey: 'ulr_your-api-key',
});
const result = await client.definitions.publish('agent', 'my-project', '1.0.0');Promise<Definition>client.definitions.deprecate()
Deprecate a published definition. Marks for removal and optionally points to a successor.
Parameters
typerequiredstringDefinition type.
agentcommandworkflowpipelinenamerequiredstringDefinition name.
versionrequiredstringDefinition version.
reasonrequiredstringReason for deprecation.
successoroptionalstringName of recommended successor definition.
deprecate(type: DefinitionType, name: string, version: string, body: DeprecateDefinitionBody): Promise<Definition>import { RegistryClient } from '@uluops/registry-sdk';
const client = new RegistryClient({
apiKey: 'ulr_your-api-key',
});
const result = await client.definitions.deprecate('agent', 'my-project', '1.0.0', 'Resolved in latest commit');Promise<Definition>client.definitions.archive()
Archive a definition. Terminal state — archived definitions cannot be un-archived. Use for end-of-life definitions.
Parameters
typerequiredstringDefinition type.
agentcommandworkflowpipelinenamerequiredstringDefinition name.
versionrequiredstringDefinition version.
archive(type: DefinitionType, name: string, version: string): Promise<Definition>import { RegistryClient } from '@uluops/registry-sdk';
const client = new RegistryClient({
apiKey: 'ulr_your-api-key',
});
const result = await client.definitions.archive('agent', 'my-project', '1.0.0');Promise<Definition>