Agent

@julep/sdk / Modules / managers/agent / AgentsManager

Class: AgentsManager

managers/agent.AgentsManager

BaseManager serves as the base class for all manager classes that interact with the Julep API. It provides common functionality needed for API interactions.

Hierarchy

• BaseManager

  ↳ AgentsManager

Table of contents

Constructors

• constructor

Properties

• apiClient

Methods

• create

• delete

• get

• list

• update

Constructors

constructor

• new AgentsManager(apiClient): AgentsManager

Constructs a new instance of BaseManager.

Parameters

Name	Type	Description
apiClient	JulepApiClient	The JulepApiClient instance used for API interactions.

Returns

AgentsManager

Inherited from

BaseManager.constructor

Defined in

src/managers/base.ts:14

Properties

apiClient

• apiClient: JulepApiClient

The JulepApiClient instance used for API interactions.

Inherited from

BaseManager.apiClient

Defined in

src/managers/base.ts:14

Methods

create

▸ create(options): Promise<Partial<Agent> & { id: string }>

Parameters

Name	Type
options	Object
options.about	string
options.default_settings?	AgentDefaultSettings
options.docs?	Doc[]
options.instructions	string | string[]
options.model?	string
options.name	string
options.tools?	CreateToolRequest[]

Returns

Promise<Partial<Agent> & { id: string }>

Defined in

src/managers/agent.ts:23

---

delete

▸ delete(agentId): Promise<void>

Parameters

Name	Type
agentId	string & Format<"uuid">

Returns

Promise<void>

Defined in

src/managers/agent.ts:108

---

get

▸ get(agentId): Promise<Agent>

Parameters

Name	Type
agentId	string & Format<"uuid">

Returns

Promise<Agent>

Defined in

src/managers/agent.ts:17

---

list

▸ list(options?): Promise<Agent[]>

Parameters

Name	Type
options	Object
options.limit?	number & Type<"uint32"> & Minimum<1> & Maximum<1000>
options.metadataFilter?	Object
options.offset?	number & Type<"uint32"> & Minimum<0>

Returns

Promise<Agent[]>

Defined in

src/managers/agent.ts:74

---

update

▸ update(agentId, request, overwrite?): Promise<Partial<Agent> & { id: string }>

Parameters

Name	Type
agentId	string
request	PatchAgentRequest
overwrite?	false

Returns

Promise<Partial<Agent> & { id: string }>

Defined in

src/managers/agent.ts:115

▸ update(agentId, request, overwrite): Promise<Partial<Agent> & { id: string }>

Parameters

Name	Type
agentId	string
request	UpdateAgentRequest
overwrite	true

Returns

Promise<Partial<Agent> & { id: string }>

Defined in

src/managers/agent.ts:121