AgentsSdkLike
Agent Runtimes / client/SdkAgentRuntimesClient / AgentsSdkLike
Interface: AgentsSdkLike
Defined in: client/SdkAgentRuntimesClient.ts:60
Structural type describing the subset of methods SdkAgentRuntimesClient
needs on the underlying SDK instance. Any DatalayerClient composed with
AgentsMixin satisfies this shape; accepting it structurally avoids a
hard type dependency on @datalayer/core inside this file, which keeps the
default implementation drop-in replaceable in alternative deployments.
Methods
approveToolRequest()
approveToolRequest(
approvalId):Promise<void>
Defined in: client/SdkAgentRuntimesClient.ts:79
Approves a pending tool execution request.
Parameters
approvalId
string
Returns
Promise<void>
createAgentRuntime()
createAgentRuntime(
data):Promise<CreateRuntimeApiResponse>
Defined in: client/SdkAgentRuntimesClient.ts:126
Creates a new agent runtime.
Parameters
data
Returns
Promise<CreateRuntimeApiResponse>
createEvent()
createEvent(
data):Promise<{event:AgentEvent;success:boolean; }>
Defined in: client/SdkAgentRuntimesClient.ts:89
Creates a new event for an agent.
Parameters
data
Returns
Promise<{ event: AgentEvent; success: boolean; }>
generateAgentOutput()
generateAgentOutput(
agentId,format,options?):Promise<OutputArtifact>
Defined in: client/SdkAgentRuntimesClient.ts:110
Generates a new output artifact.
Parameters
agentId
string
format
string
options?
Record<string, unknown>
Returns
Promise<OutputArtifact>
getAgentCheckpoints()
getAgentCheckpoints(
podName,agentId?):Promise<ConversationCheckpoint[]>
Defined in: client/SdkAgentRuntimesClient.ts:70
Lists conversation checkpoints for an agent.
Parameters
podName
string
agentId?
string
Returns
Promise<ConversationCheckpoint[]>
getAgentOutput()
getAgentOutput(
agentId,outputId):Promise<OutputArtifact>
Defined in: client/SdkAgentRuntimesClient.ts:108
Retrieves a single output artifact.
Parameters
agentId
string
outputId
string
Returns
Promise<OutputArtifact>
getAgentOutputs()
getAgentOutputs(
agentId):Promise<OutputArtifact[]>
Defined in: client/SdkAgentRuntimesClient.ts:106
Lists output artifacts for an agent.
Parameters
agentId
string
Returns
Promise<OutputArtifact[]>
getAgentStatus()
getAgentStatus(
podName,agentId?):Promise<RunningAgent>
Defined in: client/SdkAgentRuntimesClient.ts:64
Retrieves the detailed status of a specific running agent.
Parameters
podName
string
agentId?
string
Returns
Promise<RunningAgent>
getAgentUsage()
getAgentUsage(
podName,agentId?):Promise<AgentUsageSummary>
Defined in: client/SdkAgentRuntimesClient.ts:75
Retrieves the token and cost usage summary for an agent.
Parameters
podName
string
agentId?
string
Returns
Promise<AgentUsageSummary>
getContextUsage()
getContextUsage(
agentId):Promise<ContextUsage>
Defined in: client/SdkAgentRuntimesClient.ts:122
Retrieves context window usage.
Parameters
agentId
string
Returns
Promise<ContextUsage>
getCostUsage()
getCostUsage(
agentId):Promise<CostUsage>
Defined in: client/SdkAgentRuntimesClient.ts:124
Retrieves cost usage.
Parameters
agentId
string
Returns
Promise<CostUsage>
getEval()
getEval(
agentId,evalId):Promise<EvalReport>
Defined in: client/SdkAgentRuntimesClient.ts:120
Retrieves a single eval report.
Parameters
agentId
string
evalId
string
Returns
Promise<EvalReport>
getEvent()
getEvent(
agentId,eventId):Promise<GetAgentEventResponse>
Defined in: client/SdkAgentRuntimesClient.ts:98
Retrieves a single event.
Parameters
agentId
string
eventId
string
Returns
Promise<GetAgentEventResponse>
getNotifications()
getNotifications(
filters?):Promise<AgentNotification[]>
Defined in: client/SdkAgentRuntimesClient.ts:83
Lists agent notifications with optional filters.
Parameters
filters?
Returns
Promise<AgentNotification[]>
getRunningAgents()
getRunningAgents():
Promise<RunningAgent[]>
Defined in: client/SdkAgentRuntimesClient.ts:62
Lists every running agent across runtimes the caller can see.
Returns
Promise<RunningAgent[]>
getToolApprovals()
getToolApprovals(
filters?):Promise<ToolApproval[]>
Defined in: client/SdkAgentRuntimesClient.ts:77
Lists tool approval requests with optional filters.
Parameters
filters?
Returns
Promise<ToolApproval[]>
listEvals()
listEvals(
agentId):Promise<EvalReport[]>
Defined in: client/SdkAgentRuntimesClient.ts:118
Lists eval reports for an agent.
Parameters
agentId
string
Returns
Promise<EvalReport[]>
listEvents()
listEvents(
agentId,params?):Promise<ListAgentEventsResponse>
Defined in: client/SdkAgentRuntimesClient.ts:93
Lists events for an agent.
Parameters
agentId
string
params?
Omit<ListAgentEventsParams, "agent_id">
Returns
Promise<ListAgentEventsResponse>
markAllNotificationsRead()
markAllNotificationsRead():
Promise<void>
Defined in: client/SdkAgentRuntimesClient.ts:87
Marks every notification for the caller as read.
Returns
Promise<void>
markNotificationRead()
markNotificationRead(
notificationId):Promise<void>
Defined in: client/SdkAgentRuntimesClient.ts:85
Marks a single notification as read.
Parameters
notificationId
string
Returns
Promise<void>
pauseAgent()
pauseAgent(
podName):Promise<void>
Defined in: client/SdkAgentRuntimesClient.ts:66
Pauses a running agent.
Parameters
podName
string
Returns
Promise<void>
rejectToolRequest()
rejectToolRequest(
approvalId,reason?):Promise<void>
Defined in: client/SdkAgentRuntimesClient.ts:81
Rejects a pending tool execution request.
Parameters
approvalId
string
reason?
string
Returns
Promise<void>
resumeAgent()
resumeAgent(
podName):Promise<void>
Defined in: client/SdkAgentRuntimesClient.ts:68
Resumes a previously paused agent.
Parameters
podName
string
Returns
Promise<void>
runEvals()
runEvals(
agentId,request):Promise<EvalReport>
Defined in: client/SdkAgentRuntimesClient.ts:116
Runs an evaluation batch.
Parameters
agentId
string
request
Returns
Promise<EvalReport>
updateEvent()
updateEvent(
agentId,eventId,data):Promise<GetAgentEventResponse>
Defined in: client/SdkAgentRuntimesClient.ts:100
Updates an event.
Parameters
agentId
string
eventId
string
data
Returns
Promise<GetAgentEventResponse>