Class Agents

Hierarchy

APIResource
- Agents

Index

Constructors

Properties

Methods

create retrieve list

Constructors

constructor

new Agents(client: Runloop): Agents
Parameters
- client: Runloop
Returns Agents
Inherited from APIResource.constructor
- Defined in src/resource.ts:8

Properties

`Protected`_client

_client: Runloop

Methods

create

create(
body: AgentCreateParams,
options?: RequestOptions<unknown>,
): APIPromise<AgentView>
Create a new Agent with a name and optional public visibility. The Agent will be assigned a unique ID.
Parameters
- body: AgentCreateParams
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<AgentView>
- Defined in src/resources/agents.ts:14

retrieve

retrieve(id: string, options?: RequestOptions<unknown>): APIPromise<AgentView>
Retrieve a specific Agent by its unique identifier.
Parameters
- id: string
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<AgentView>
- Defined in src/resources/agents.ts:21

list

list(
query?: AgentListParams,
options?: RequestOptions<unknown>,
): PagePromise<AgentViewsAgentsCursorIDPage, AgentView>
List all Agents for the authenticated account with pagination support.
Parameters
- Optionalquery: AgentListParams
- Optionaloptions: RequestOptions<unknown>
Returns PagePromise<AgentViewsAgentsCursorIDPage, AgentView>
- Defined in src/resources/agents.ts:28
list(
options?: RequestOptions<unknown>,
): PagePromise<AgentViewsAgentsCursorIDPage, AgentView>
List all Agents for the authenticated account with pagination support.
Parameters
- Optionaloptions: RequestOptions<unknown>
Returns PagePromise<AgentViewsAgentsCursorIDPage, AgentView>
- Defined in src/resources/agents.ts:32