PURISTA API

---

PURISTA API / @purista/ai / createEnvelopeFromContext

Function: createEnvelopeFromContext()

createEnvelopeFromContext(context, frame, overrides?): object

Defined in: packages/ai/src/protocol/purista.ts:36

Parameters

context

ContextBase & object

frame

{ content: string; final?: boolean; kind: "message"; partial?: boolean; role: "user" | "assistant" | "system" | "tool"; summary?: string; } | { artifactId: string; content: string | Record<string, unknown>; kind: "artifact"; lastChunk?: boolean; mimeType?: string; phase: "final" | "chunk"; sequence?: number; total?: number; } | { errorCode?: string; input?: unknown; kind: "tool"; message?: string; output?: unknown; status: "error" | "success" | "invoked"; toolName: string; } | { activeWorkers?: number; durationMs?: number; effectiveMaxConcurrencyHint?: number; kind: "telemetry"; maxWorkersPerInstance?: number; poolId?: string; provider?: string; replicaCountHint?: number; usage?: { completionTokens?: number; costUsd?: number; promptTokens?: number; totalTokens?: number; }; waitingWorkers?: number; waitTimeMs?: number; } | { code: string; details?: unknown; handled: boolean; kind: "error"; message: string; }

overrides?

PuristaProtocolOptions

Returns

object

actor

actor: object = protocolActorSchema

actor.agent?

optional agent: string

actor.instanceId?

optional instanceId: string

actor.service

service: string

actor.version?

optional version: string

conversationId

conversationId: string

frame

frame: { content: string; final?: boolean; kind: "message"; partial?: boolean; role: "user" | "assistant" | "system" | "tool"; summary?: string; } | { artifactId: string; content: string | Record<string, unknown>; kind: "artifact"; lastChunk?: boolean; mimeType?: string; phase: "final" | "chunk"; sequence?: number; total?: number; } | { errorCode?: string; input?: unknown; kind: "tool"; message?: string; output?: unknown; status: "error" | "success" | "invoked"; toolName: string; } | { activeWorkers?: number; durationMs?: number; effectiveMaxConcurrencyHint?: number; kind: "telemetry"; maxWorkersPerInstance?: number; poolId?: string; provider?: string; replicaCountHint?: number; usage?: { completionTokens?: number; costUsd?: number; promptTokens?: number; totalTokens?: number; }; waitingWorkers?: number; waitTimeMs?: number; } | { code: string; details?: unknown; handled: boolean; kind: "error"; message: string; } = agentProtocolFrameSchema

inReplyTo?

optional inReplyTo: string

messageId

messageId: string

metadata?

optional metadata: Record<string, unknown>

role?

optional role: "user" | "assistant" | "system" | "tool"

tenantId?

optional tenantId: string

timestamp

timestamp: string

userId?

optional userId: string

version

version: "purista.ai/1.0"