makima-ts
Version:
Typescript SDK for Makima.
54 lines (53 loc) • 1.85 kB
TypeScript
import { AgentParams } from './types';
/**
* Class representing the Agent API.
*/
declare class AgentAPI {
private baseUrl;
constructor(baseUrl: string);
/**
* Get all agents in the system.
* @returns A promise resolving to the list of agents.
*/
getAll(): Promise<any>;
/**
* Get the details of an agent by its name.
* @param name The name of the agent.
* @returns A promise resolving to the agent details.
*/
get(name: string): Promise<any>;
/**
* Create a new agent with the provided details.
* @param params The agent details.
* @returns A promise resolving to the created agent.
*/
create(params: AgentParams): Promise<any>;
/**
* Update the details of an existing agent by its name.
* @param name The name of the agent.
* @param params The agent details to update.
* @returns A promise resolving to the updated agent.
*/
update(name: string, params: Partial<AgentParams>): Promise<any>;
/**
* Delete an agent by its name.
* @param name The name of the agent.
* @returns A promise resolving to the result of the deletion.
*/
delete(name: string): Promise<any>;
/**
* Add a tool to an agent by the agent name and tool name.
* @param agentName The name of the agent.
* @param toolName The name of the tool.
* @returns A promise resolving to the result of the operation.
*/
addTool(agentName: string, toolName: string): Promise<any>;
/**
* Remove a tool from an agent by the agent name and tool name.
* @param agentName The name of the agent.
* @param toolName The name of the tool.
* @returns A promise resolving to the result of the operation.
*/
removeTool(agentName: string, toolName: string): Promise<any>;
}
export { AgentAPI };