IOrganizationAgentsService
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
This service provides access to AI agents and their skills in the organization.
export interface IOrganizationAgentsService
Methods
Method | Description |
|---|---|
(ALPHA) Create a new agent. | |
(ALPHA) Delete an agent. | |
(ALPHA) Get agent by ref. | |
(ALPHA) Get agents query. | |
(ALPHA) Get all available skills for the AI agent. | |
(ALPHA) Patch existing agent (partial update). | |
(ALPHA) Update existing agent (full replace). |
Method details
IOrganizationAgentsService.createAgent()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Create a new agent.
createAgent(agent: IAgent): Promise<IAgent>;
Parameters
Parameter | Type | Description |
|---|---|---|
agent | definition of the agent |
Returns
Promise<IAgent>
Promise resolved with created agent.
IOrganizationAgentsService.deleteAgent()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Delete an agent.
deleteAgent(ref: ObjRef): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
ref | ref of the agent |
Returns
Promise<void>
Promise resolved when the agent is deleted.
IOrganizationAgentsService.getAgent()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Get agent by ref.
getAgent(ref: ObjRef): Promise<IAgent | undefined>;
Parameters
Parameter | Type | Description |
|---|---|---|
ref | ref of the agent |
Returns
Promise<IAgent | undefined>
Promise resolved with agent.
IOrganizationAgentsService.getAgentsQuery()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Get agents query.
getAgentsQuery(): IAgentsQuery;
Returns
agents query
IOrganizationAgentsService.getAvailableSkills()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Get all available skills for the AI agent.
getAvailableSkills(): Promise<IAgentSkill[]>;
Returns
Promise<IAgentSkill[]>
Promise resolved with a list of available skills.
IOrganizationAgentsService.patchAgent()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Patch existing agent (partial update).
patchAgent(agent: IAgentPatch): Promise<IAgent>;
Parameters
Parameter | Type | Description |
|---|---|---|
agent | partial definition of the agent |
Returns
Promise<IAgent>
Promise resolved with patched agent.
IOrganizationAgentsService.updateAgent()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Update existing agent (full replace).
updateAgent(agent: IAgent): Promise<IAgent>;
Parameters
Parameter | Type | Description |
|---|---|---|
agent | definition of the agent |
Returns
Promise<IAgent>
Promise resolved with updated agent.