Skip to content

bodhi-realtime-agent / SaveArtifactParams

Interface: SaveArtifactParams

Defined in: types/workspace.ts:4

Parameters for saving an artifact produced by an agent or tool.

Properties

agentName?

optional agentName: string

Defined in: types/workspace.ts:10

Name of the agent that produced the artifact.


content

content: Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>

Defined in: types/workspace.ts:16

Raw bytes.


metadata?

optional metadata: Record<string, unknown>

Defined in: types/workspace.ts:18

Optional metadata (filename, dimensions, etc.).


mimeType

mimeType: string

Defined in: types/workspace.ts:14

MIME type (e.g. image/png, application/pdf).


sessionId?

optional sessionId: string

Defined in: types/workspace.ts:6

Session that produced the artifact (injected by session.workspace when omitted).


toolCallId?

optional toolCallId: string

Defined in: types/workspace.ts:12

Tool call that produced the artifact (for correlation).


userId?

optional userId: string

Defined in: types/workspace.ts:8

User context (injected by session.workspace when omitted).

Built with VitePress