Skip to content

agentic.Artifact

Page status: scaffold Source state: generated Applies to: Shepherd v1.0-dev Owner: @docs-system-owner (TBD) Validation: scripts/gen_shepherd_api_inventory.py --check

This is reference — exact, generated facts. The mental model lives in concepts; recipes live in guides.

Pre-rename surface

Generated from the internal agentic facade; names and paths change at the Shepherd rename.

class

Artifact dataclass

Durable artifact produced during a task run.

Frozen dataclass per DECISIONS D17 (cross-plan trace boundary types are frozen dataclasses with JSON-compatible leaves). The content accepts str or bytes for text vs. binary artifacts; metadata is a JSON-serializable dict for provider-specific extras.

content instance-attribute 

content: str | bytes

kind instance-attribute 

kind: str

metadata class-attribute instance-attribute 

metadata: dict[str, Any] = field(default_factory=dict)

name instance-attribute 

name: str

__init__ 

__init__(
    kind: str,
    name: str,
    content: str | bytes,
    metadata: dict[str, Any] = dict(),
) -> None

See also