Class AgentsClient

Index

Constructors

constructor

new AgentsClient(options: BaseClientOptions): AgentsClient
Parameters
- options: BaseClientOptions
Returns AgentsClient

Methods

list

list(
request?: ListAgentsRequestParameters,
requestOptions?: AgentsClient.RequestOptions,
): Promise<Page<AgentResponseContent, ListAgentsResponseContent>>
Get agents
Parameters
- request: ListAgentsRequestParameters = {}
- OptionalrequestOptions: AgentsClient.RequestOptions
  Request-specific configuration.
Returns Promise<Page<AgentResponseContent, ListAgentsResponseContent>>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.agents.list({
        from: "from",
        take: 1
    })
```

create

create(
request: CreateAgentRequestContent,
requestOptions?: AgentsClient.RequestOptions,
): HttpResponsePromise<AgentResponseContent>
Create an agent
Parameters
- request: CreateAgentRequestContent
- OptionalrequestOptions: AgentsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<AgentResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.ConflictError

Throws
Management.TooManyRequestsError
Example
```
await client.agents.create({
        name: "name"
    })
```

read

read(
id: string,
requestOptions?: AgentsClient.RequestOptions,
): HttpResponsePromise<AgentResponseContent>
Get an agent
Parameters
- id: string
  The agent ID
- OptionalrequestOptions: AgentsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<AgentResponseContent>
Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.agents.read("id")
```

delete

delete(
id: string,
requestOptions?: AgentsClient.RequestOptions,
): HttpResponsePromise<void>
Delete an agent
Parameters
- id: string
  The agent ID
- OptionalrequestOptions: AgentsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.agents.delete("id")
```

update

update(
    id: string,
    request?: PatchAgentRequestParameters,
    requestOptions?: AgentsClient.RequestOptions,
): HttpResponsePromise<AgentResponseContent>
Update an agent
Parameters
- id: string
  The agent ID
- request: PatchAgentRequestParameters = {}
- OptionalrequestOptions: AgentsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<AgentResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.agents.update("id")
```

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Class AgentsClient

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns AgentsClient

Methods

list

Parameters

Returns Promise<Page<AgentResponseContent, ListAgentsResponseContent>>

Throws

Throws

Throws

Throws

Example

create

Parameters

Returns HttpResponsePromise<AgentResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

read

Parameters

Returns HttpResponsePromise<AgentResponseContent>

Throws

Throws

Throws

Throws

Example

delete

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Throws

Example

update

Parameters

Returns HttpResponsePromise<AgentResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

Properties

Protected Readonly_options

Settings

On This Page

`Protected` `Readonly`_options