IAgent
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Represents an AI agent entity.
export interface IAgent
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
boolean | (ALPHA) (Optional) Whether AI Knowledge base is enabled. | ||
boolean | (ALPHA) (Optional) Whether the agent is available to all users. | ||
string | (ALPHA) (Optional) Creation timestamp. | ||
(ALPHA) (Optional) User who created the agent. | |||
AgentCustomSkill[] | null | (ALPHA) (Optional) List of custom skills when skillsMode is “custom”. | ||
string | (ALPHA) (Optional) Agent description. | ||
boolean | (ALPHA) (Optional) Whether the agent is enabled. | ||
(ALPHA) (Optional) Rules the agent follows when answering. An empty list must be sent as undefined — the backend omits the field rather than returning | |||
boolean | (ALPHA) (Optional) Whether this agent is a preview agent, scoped to a single (user, workspace) pair. The agent id must match the pattern | ||
string | (ALPHA) (Optional) Last time the agent was used by the current user. | ||
string | (ALPHA) (Optional) Last modification timestamp. | ||
(ALPHA) (Optional) User who last modified the agent. | |||
string | (ALPHA) (Optional) Agent name. | ||
string | (ALPHA) (Optional) Agent personality prompt. | ||
(ALPHA) Agent reference. | |||
(ALPHA) (Optional) Skills mode - “all” uses all skills, “custom” uses only selected skills. | |||
(ALPHA) (Optional) User groups the agent is associated with. |
Property details
IAgent.aiKnowledgepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Whether AI Knowledge base is enabled.
aiKnowledge?: boolean;
IAgent.availableToAllpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Whether the agent is available to all users.
availableToAll?: boolean;
IAgent.createdAtpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Creation timestamp.
createdAt?: string;
IAgent.createdBypropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
User who created the agent.
createdBy?: IUser;
IAgent.customSkillspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
List of custom skills when skillsMode is “custom”.
customSkills?: AgentCustomSkill[] | null;
IAgent.descriptionpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Agent description.
description?: string;
IAgent.enabledpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Whether the agent is enabled.
enabled?: boolean;
IAgent.instructionspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Rules the agent follows when answering. An empty list must be sent as undefined — the backend omits the field rather than returning [], so [] would read as a change against a fresh agent.
instructions?: IAgentInstruction[];
IAgent.isPreviewpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Whether this agent is a preview agent, scoped to a single (user, workspace) pair. The agent id must match the pattern {userId}-{workspaceId}-preview.
isPreview?: boolean;
IAgent.lastUsedAtpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Last time the agent was used by the current user.
lastUsedAt?: string;
IAgent.modifiedAtpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Last modification timestamp.
modifiedAt?: string;
IAgent.modifiedBypropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
User who last modified the agent.
modifiedBy?: IUser;
IAgent.namepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Agent name.
name?: string;
IAgent.personalitypropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Agent personality prompt.
personality?: string;
IAgent.refpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Agent reference.
ref: ObjRef;
IAgent.skillsModepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Skills mode - “all” uses all skills, “custom” uses only selected skills.
skillsMode?: AgentSkillsMode;
IAgent.userGroupspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
User groups the agent is associated with.
userGroups?: IUserGroup[];