Render

Markdown rendering operations. Get rendered agent prompts or preview YAML without storing.

2 methods

client.render.get()

Get the rendered markdown for a stored definition. The rendered output is the runtime agent prompt.

Parameters

typerequiredstring

Definition type.

agentcommandworkflowpipeline

namerequiredstring

Definition name.

versionrequiredstring

Definition version.

renderProfileoptionalstring

Render profile preset.

coreuluops-full

targetoptionalstring

Target harness format (e.g., opencode, codex, gemini).

modeloptionalstring

Model override for target envelope.

Return Fields

markdownrequiredstring

Rendered markdown content.

promptHashoptionalstring | null

SHA-256 hash of rendered content.

targetoptionalstring

Target that was rendered (when target param specified).

warningsoptionalTargetWarning[]

Adapter warnings about lossy mappings.

variablesoptionalstring[]

Template variables used.

metadataoptionalobject

Render metadata.

get(type: DefinitionType, name: string, version: string, options?: RenderGetOptions): Promise<RenderResult>

typescript

import { RegistryClient } from '@uluops/registry-sdk';

const client = new RegistryClient({
  apiKey: 'ulr_your-api-key',
});

const result = await client.render.get('agent', 'my-project', '1.0.0');

console.log(result.markdown);

Response Type

// Promise<RenderResult>
{
  markdown: string;
  promptHash?: string | null;
  target?: string;
  warnings?: TargetWarning[];
  variables?: string[];
  metadata?: object;
}

client.render.preview()

Preview render YAML without storing. Useful for testing definition content before creating.

Parameters

typerequiredstring

Definition type.

agentcommandworkflowpipeline

yamlrequiredstring

YAML content to render (max 100KB).

sourcePathoptionalstring

Optional source file path for context.

renderProfileoptionalstring

Render profile preset.

coreuluops-full

preview(type: DefinitionType, body: RenderPreviewBody): Promise<RenderResult>

typescript

import { RegistryClient } from '@uluops/registry-sdk';

const client = new RegistryClient({
  apiKey: 'ulr_your-api-key',
});

const result = await client.render.preview('agent', 'name: example-agent\nversion: 1.0.0');

Response Type

Promise<RenderResult>