Skip to main content

History API

History API

import { CodeBoltClient } from '@codebolt/clientsdk';

const client = new CodeBoltClient();

Quick Reference

MethodDescription
getByAgentIdRetrieves the execution history for a specific agent.

Methods


getByAgentId

client.history.getByAgentId(agentId: string): Promise<HistoryEntry[]>

Retrieves the execution history for a specific agent.

Returns an ordered list of history entries documenting every action the agent performed, including timestamps and payloads. Useful for reviewing what an agent did during a session.

ParameterTypeRequiredDescription
agentIdstringYesThe unique identifier of the agent whose history to retrieve

Returns: Promise<HistoryEntry[]> — A promise that resolves to an array of objects in chronological order

Full reference →