AgentsOperations
The agents.* operations.
Methods
Section titled “Methods”list()
Section titled “list()”list(input?, options?): Promise<Agents>;List agents.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
input? |
{ agents?: string[]; after?: string; limit?: number; } |
- |
input.agents? |
string[] |
Agent IDs, each listed once. Each includes its conversations. Defaults to every agent you can access. |
input.after? |
string |
Return results after this cursor. Use the next value from the previous page. |
input.limit? |
number |
The maximum number to return. Defaults to all. |
options? |
CallOptions |
- |
Returns
Section titled “Returns”Promise<Agents>
forget()
Section titled “forget()”forget(input?, options?): Promise<Forgotten>;Delete agents.
Removes each agent in the same way as agent.forget. The agent is stopped, and its conversations, definition and triggers are deleted.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
input? |
{ agents?: string[]; } |
- |
input.agents? |
string[] |
Agent IDs, each listed once. Each includes its conversations. Defaults to every agent you can access. |
options? |
CallOptions |
- |
Returns
Section titled “Returns”Promise<Forgotten>
cancel()
Section titled “cancel()”cancel(input?, options?): Promise<string[]>;Cancel the current turn of several agents.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
input? |
{ agents?: string[]; } |
- |
input.agents? |
string[] |
Agent IDs, each listed once. Each includes its conversations. Defaults to every agent you can access. |
options? |
CallOptions |
- |
Returns
Section titled “Returns”Promise<string[]>