Skip to main content

Agents

Workspace API

Workspace API / models/Agents

models/Agents

Functions​

getAgents()​

getAgents(userId, organizationId): Promise<Agent[]>

Defined in: models/Agents.ts:81

Get all agents for an organization or user (including system agents)

Parameters​

userId​

string

organizationId​

string

Returns​

Promise<Agent[]>

getAgentByKey()​

getAgentByKey(userId, organizationId, agentKey): Promise<Agent | null>

Defined in: models/Agents.ts:109

Get an agent by key

Parameters​

userId​

string

organizationId​

string

agentKey​

string

Returns​

Promise<Agent | null>

getAgentById()​

getAgentById(userId, organizationId, agentId): Promise<Agent | null>

Defined in: models/Agents.ts:142

Get an agent by ID

Parameters​

userId​

string

organizationId​

string

agentId​

string

Returns​

Promise<Agent | null>

getActiveAgentVersion()​

getActiveAgentVersion(userId, organizationId, agentId): Promise<AgentVersion | null>

Defined in: models/Agents.ts:179

Get active version for an agent

Parameters​

userId​

string

organizationId​

string

agentId​

string

Returns​

Promise<AgentVersion | null>

getAgentVersions()​

getAgentVersions(userId, organizationId, agentId): Promise<AgentVersion[]>

Defined in: models/Agents.ts:217

Get all versions for an agent

Parameters​

userId​

string

organizationId​

string

agentId​

string

Returns​

Promise<AgentVersion[]>

getAgentVersionById()​

getAgentVersionById(userId, organizationId, versionId): Promise<AgentVersion | null>

Defined in: models/Agents.ts:252

Get a specific version by ID

Parameters​

userId​

string

organizationId​

string

versionId​

string

Returns​

Promise<AgentVersion | null>

createAgentWithVersion()​

createAgentWithVersion(userId, organizationId, data): Promise<{ agent: Agent; version: AgentVersion; }>

Defined in: models/Agents.ts:292

Create a new agent with initial version (transaction)

Parameters​

userId​

string

organizationId​

string

data​

CreateAgentWithVersionData

Returns​

Promise<{ agent: Agent; version: AgentVersion; }>

createAgentVersion()​

createAgentVersion(userId, organizationId, agentId, data): Promise<AgentVersion>

Defined in: models/Agents.ts:407

Create a new version for an existing agent

Parameters​

userId​

string

organizationId​

string

agentId​

string

data​

CreateAgentVersionData

Returns​

Promise<AgentVersion>

createDraftAgentVersion()​

createDraftAgentVersion(userId, organizationId, agentId, data): Promise<AgentVersion>

Defined in: models/Agents.ts:464

Create a new draft version for an existing agent (auto-increment version_number)

Parameters​

userId​

string

organizationId​

string

agentId​

string

data​

CreateDraftAgentVersionData

Returns​

Promise<AgentVersion>

setActiveVersion()​

setActiveVersion(userId, organizationId, agentId, versionId): Promise<void>

Defined in: models/Agents.ts:547

Set active version for an agent (archives previous active version) Uses atomic CTE to prevent race conditions

Parameters​

userId​

string

organizationId​

string

agentId​

string

versionId​

string

Returns​

Promise<void>

publishAgentVersion()​

publishAgentVersion(versionId, organizationId, userId): Promise<{ agentId: string; versionId: string; versionNumber: number; previousVersionId: string | null; }>

Defined in: models/Agents.ts:592

Publish a draft agent version

Parameters​

versionId​

string

organizationId​

string

userId​

string

Returns​

Promise<{ agentId: string; versionId: string; versionNumber: number; previousVersionId: string | null; }>

rollbackAgentVersion()​

rollbackAgentVersion(targetVersionId, organizationId, userId, reason?): Promise<{ agentId: string; versionId: string; versionNumber: number; previousVersionId: string | null; targetVersionId: string; }>

Defined in: models/Agents.ts:675

Rollback to a previous agent version

Parameters​

targetVersionId​

string

organizationId​

string

userId​

string

reason?​

string

Returns​

Promise<{ agentId: string; versionId: string; versionNumber: number; previousVersionId: string | null; targetVersionId: string; }>

updateAgent()​

updateAgent(userId, organizationId, agentId, data): Promise<Agent>

Defined in: models/Agents.ts:818

Update agent metadata

Parameters​

userId​

string

organizationId​

string

agentId​

string

data​

UpdateAgentData

Returns​

Promise<Agent>

updateAgentVersion()​

updateAgentVersion(userId, organizationId, agentId, versionId, data): Promise<AgentVersion>

Defined in: models/Agents.ts:870

Update a draft agent version

Parameters​

userId​

string

organizationId​

string

agentId​

string

versionId​

string

data​

UpdateAgentVersionData

Returns​

Promise<AgentVersion>

deleteAgent()​

deleteAgent(userId, organizationId, agentId): Promise<void>

Defined in: models/Agents.ts:953

Delete an agent (soft delete - sets active_version_id to NULL)

Parameters​

userId​

string

organizationId​

string

agentId​

string

Returns​

Promise<void>