Briefs Client

The briefs client gives you access to your agent's knowledge briefs - compiled summaries of what the agent knows and what it's missing.

Methods

`get(agent_id, version)`

Get a knowledge brief for an agent.

brief = await client.briefs.get(agent_id="your-agent-id")
print(f"Version: {brief.version}")
print(f"Compiled: {brief.compiled_at}")
print(f"Brief: {brief.brief}")
print(f"Gaps: {brief.gap_summary}")

Parameters:

Name	Type	Default	Description
`agent_id`	`str`	required	The agent to get the brief for
`version`	`str \| None`	`None`	Specific version (defaults to latest)

Returns: Brief

`version(agent_id)`

Check the brief version status - whether a newer version is available.

ver = await client.briefs.version(agent_id="your-agent-id")
print(f"Current: {ver.current_version}")
print(f"Latest: {ver.latest_version}")
print(f"Has update: {ver.has_update}")

Returns: BriefVersion

`diff(agent_id, from_version, to_version)`

Compare two brief versions to see what changed.

diff = await client.briefs.diff(
    agent_id="your-agent-id",
    from_version="1",
    to_version="3",
)
print(f"Changes from v{diff.from_version} to v{diff.to_version}:")
print(diff.summary)

Parameters:

Name	Type	Description
`agent_id`	`str`	The agent
`from_version`	`str`	Starting version
`to_version`	`str`	Ending version

Returns: BriefDiff

`compile(agent_id)`

Trigger a manual recompilation of the knowledge brief. Useful after your agent has had significant new activity.

result = await client.briefs.compile(agent_id="your-agent-id")
print(result)  # Compilation accepted

Returns: Compilation status

Data Models

`Brief`

@dataclass
class Brief:
    agent_id: str
    version: str
    previous_version: str | None
    compiled_at: str | None
    brief: str                      # The compiled brief text
    gap_summary: list[str]          # Identified knowledge gaps

`BriefVersion`

@dataclass
class BriefVersion:
    current_version: str
    latest_version: str
    has_update: bool
    latest_compiled_at: str | None

`BriefDiff`

@dataclass
class BriefDiff:
    from_version: str
    to_version: str
    summary: str
    generated_at: str | None

Next Steps

Knowledge Briefs (Dashboard) - visual brief management
Discovery Client - discovery uses briefs to find gaps

Briefs Client

On this page