agents

Workspace API

---

Workspace API / types/agents

types/agents

Interfaces

Agent

Defined in: types/agents.ts:24

Agent - base agent record

Extended by

• AgentWithVersion

Properties

id

id: string

Defined in: types/agents.ts:25

organization_id

organization_id: string | null

Defined in: types/agents.ts:26

user_id

user_id: string | null

Defined in: types/agents.ts:27

agent_key

agent_key: string

Defined in: types/agents.ts:28

name

name: string

Defined in: types/agents.ts:29

description

description: string | null

Defined in: types/agents.ts:30

active_version_id

active_version_id: string | null

Defined in: types/agents.ts:31

created_at

created_at: string

Defined in: types/agents.ts:32

updated_at

updated_at: string

Defined in: types/agents.ts:33

created_by

created_by: string | null

Defined in: types/agents.ts:34

metadata

metadata: Record<string, unknown>

Defined in: types/agents.ts:35

---

AgentVersion

Defined in: types/agents.ts:41

Agent Version - immutable agent version record

Properties

id

id: string

Defined in: types/agents.ts:42

agent_id

agent_id: string

Defined in: types/agents.ts:43

version_number

version_number: number

Defined in: types/agents.ts:44

instructions

instructions: string

Defined in: types/agents.ts:45

model_name

model_name: string

Defined in: types/agents.ts:46

temperature

temperature: number

Defined in: types/agents.ts:47

max_output_tokens

max_output_tokens: number

Defined in: types/agents.ts:48

tools

tools: Record<string, unknown>[] | null

Defined in: types/agents.ts:49

status

status: AgentVersionStatus

Defined in: types/agents.ts:50

published_at

published_at: string | null

Defined in: types/agents.ts:51

published_by

published_by: string | null

Defined in: types/agents.ts:52

created_at

created_at: string

Defined in: types/agents.ts:53

created_by

created_by: string | null

Defined in: types/agents.ts:54

metadata

metadata: Record<string, unknown>

Defined in: types/agents.ts:55

---

AgentWithVersion

Defined in: types/agents.ts:61

Agent with active version - joined query result

Extends

• Agent

Properties

id

id: string

Defined in: types/agents.ts:25

Inherited from

Agent.id

organization_id

organization_id: string | null

Defined in: types/agents.ts:26

Inherited from

Agent.organization_id

user_id

user_id: string | null

Defined in: types/agents.ts:27

Inherited from

Agent.user_id

agent_key

agent_key: string

Defined in: types/agents.ts:28

Inherited from

Agent.agent_key

name

name: string

Defined in: types/agents.ts:29

Inherited from

Agent.name

description

description: string | null

Defined in: types/agents.ts:30

Inherited from

Agent.description

active_version_id

active_version_id: string | null

Defined in: types/agents.ts:31

Inherited from

Agent.active_version_id

created_at

created_at: string

Defined in: types/agents.ts:32

Inherited from

Agent.created_at

updated_at

updated_at: string

Defined in: types/agents.ts:33

Inherited from

Agent.updated_at

created_by

created_by: string | null

Defined in: types/agents.ts:34

Inherited from

Agent.created_by

metadata

metadata: Record<string, unknown>

Defined in: types/agents.ts:35

Inherited from

Agent.metadata

version

version: AgentVersion | null

Defined in: types/agents.ts:62

---

CreateAgentData

Defined in: types/agents.ts:72

Input data for creating a new agent

Properties

organization_id?

optional organization_id: string | null

Defined in: types/agents.ts:73

user_id?

optional user_id: string | null

Defined in: types/agents.ts:74

agent_key

agent_key: string

Defined in: types/agents.ts:75

name

name: string

Defined in: types/agents.ts:76

description?

optional description: string | null

Defined in: types/agents.ts:77

created_by?

optional created_by: string | null

Defined in: types/agents.ts:78

metadata?

optional metadata: Record<string, unknown>

Defined in: types/agents.ts:79

---

CreateAgentVersionData

Defined in: types/agents.ts:85

Input data for creating a new agent version

Properties

version_number

version_number: number

Defined in: types/agents.ts:86

instructions

instructions: string

Defined in: types/agents.ts:87

model_name?

optional model_name: string

Defined in: types/agents.ts:88

temperature?

optional temperature: number

Defined in: types/agents.ts:89

max_output_tokens?

optional max_output_tokens: number

Defined in: types/agents.ts:90

tools?

optional tools: Record<string, unknown>[] | null

Defined in: types/agents.ts:91

status?

optional status: AgentVersionStatus

Defined in: types/agents.ts:92

published_at?

optional published_at: string | null

Defined in: types/agents.ts:93

published_by?

optional published_by: string | null

Defined in: types/agents.ts:94

created_by?

optional created_by: string | null

Defined in: types/agents.ts:95

metadata?

optional metadata: Record<string, unknown>

Defined in: types/agents.ts:96

---

CreateDraftAgentVersionData

Defined in: types/agents.ts:102

Input data for creating a draft agent version

Properties

instructions

instructions: string

Defined in: types/agents.ts:103

model_name?

optional model_name: string

Defined in: types/agents.ts:104

temperature?

optional temperature: number

Defined in: types/agents.ts:105

max_output_tokens?

optional max_output_tokens: number

Defined in: types/agents.ts:106

tools?

optional tools: Record<string, unknown>[] | null

Defined in: types/agents.ts:107

created_by?

optional created_by: string | null

Defined in: types/agents.ts:108

metadata?

optional metadata: Record<string, unknown>

Defined in: types/agents.ts:109

---

RollbackMetadata

Defined in: types/agents.ts:115

Rollback metadata stored in agent version metadata JSONB

Properties

rollback

rollback: object

Defined in: types/agents.ts:116

from_version_id

from_version_id: string | null

to_version_id

to_version_id: string

reason

reason: string | null

---

UpdateAgentData

Defined in: types/agents.ts:126

Input data for updating agent metadata

Properties

name?

optional name: string

Defined in: types/agents.ts:127

description?

optional description: string | null

Defined in: types/agents.ts:128

metadata?

optional metadata: Record<string, unknown>

Defined in: types/agents.ts:129

---

UpdateAgentVersionData

Defined in: types/agents.ts:135

Input data for updating a draft agent version

Properties

instructions?

optional instructions: string

Defined in: types/agents.ts:136

model_name?

optional model_name: string

Defined in: types/agents.ts:137

temperature?

optional temperature: number

Defined in: types/agents.ts:138

max_output_tokens?

optional max_output_tokens: number

Defined in: types/agents.ts:139

tools?

optional tools: Record<string, unknown>[] | null

Defined in: types/agents.ts:140

metadata?

optional metadata: Record<string, unknown>

Defined in: types/agents.ts:141

---

CreateAgentWithVersionData

Defined in: types/agents.ts:147

Input data for creating agent with initial version (transaction)

Properties

agent

agent: CreateAgentData

Defined in: types/agents.ts:148

version

version: Omit<CreateAgentVersionData, "version_number">

Defined in: types/agents.ts:149

---

AgentListItem

Defined in: types/agents.ts:159

Agent list item - agent with active version summary

Properties

id

id: string

Defined in: types/agents.ts:160

organization_id

organization_id: string | null

Defined in: types/agents.ts:161

user_id

user_id: string | null

Defined in: types/agents.ts:162

agent_key

agent_key: string

Defined in: types/agents.ts:163

name

name: string

Defined in: types/agents.ts:164

description

description: string | null

Defined in: types/agents.ts:165

active_version_id

active_version_id: string | null

Defined in: types/agents.ts:166

active_version_number

active_version_number: number | null

Defined in: types/agents.ts:167

active_version_status

active_version_status: AgentVersionStatus | null

Defined in: types/agents.ts:168

created_at

created_at: string

Defined in: types/agents.ts:169

updated_at

updated_at: string

Defined in: types/agents.ts:170

created_by

created_by: string | null

Defined in: types/agents.ts:171

---

AgentVersionListItem

Defined in: types/agents.ts:177

Agent version list item - version summary

Properties

id

id: string

Defined in: types/agents.ts:178

agent_id

agent_id: string

Defined in: types/agents.ts:179

version_number

version_number: number

Defined in: types/agents.ts:180

status

status: AgentVersionStatus

Defined in: types/agents.ts:181

model_name

model_name: string

Defined in: types/agents.ts:182

published_at

published_at: string | null

Defined in: types/agents.ts:183

published_by

published_by: string | null

Defined in: types/agents.ts:184

created_at

created_at: string

Defined in: types/agents.ts:185

created_by

created_by: string | null

Defined in: types/agents.ts:186

---

AgentRow

Defined in: types/agents.ts:197

Agent database row (snake_case from database) Note: Slonik returns dates as ISO strings

Properties

id

id: string

Defined in: types/agents.ts:198

organization_id

organization_id: string | null

Defined in: types/agents.ts:199

user_id

user_id: string | null

Defined in: types/agents.ts:200

agent_key

agent_key: string

Defined in: types/agents.ts:201

name

name: string

Defined in: types/agents.ts:202

description

description: string | null

Defined in: types/agents.ts:203

active_version_id

active_version_id: string | null

Defined in: types/agents.ts:204

created_at

created_at: string | Date

Defined in: types/agents.ts:205

updated_at

updated_at: string | Date

Defined in: types/agents.ts:206

created_by

created_by: string | null

Defined in: types/agents.ts:207

metadata

metadata: Record<string, unknown>

Defined in: types/agents.ts:208

---

AgentVersionRow

Defined in: types/agents.ts:215

Agent version database row (snake_case from database) Note: Slonik returns dates as ISO strings

Properties

id

id: string

Defined in: types/agents.ts:216

agent_id

agent_id: string

Defined in: types/agents.ts:217

version_number

version_number: number

Defined in: types/agents.ts:218

instructions

instructions: string

Defined in: types/agents.ts:219

model_name

model_name: string

Defined in: types/agents.ts:220

temperature

temperature: number

Defined in: types/agents.ts:221

max_output_tokens

max_output_tokens: number

Defined in: types/agents.ts:222

tools

tools: Record<string, unknown>[] | null

Defined in: types/agents.ts:223

status

status: AgentVersionStatus

Defined in: types/agents.ts:224

published_at

published_at: string | Date | null

Defined in: types/agents.ts:225

published_by

published_by: string | null

Defined in: types/agents.ts:226

created_at

created_at: string | Date

Defined in: types/agents.ts:227

created_by

created_by: string | null

Defined in: types/agents.ts:228

metadata

metadata: Record<string, unknown>

Defined in: types/agents.ts:229

Type Aliases

AgentVersionStatus

AgentVersionStatus = "draft" | "active" | "archived"

Defined in: types/agents.ts:15

Agent version status enum

Variables

AGENT_KEY_REGEX

const AGENT_KEY_REGEX: RegExp

Defined in: types/agents.ts:239

Agent key format regex (kebab-case)

---

VALID_VERSION_TRANSITIONS

const VALID_VERSION_TRANSITIONS: Record<AgentVersionStatus, AgentVersionStatus[]>

Defined in: types/agents.ts:290

Valid version status transitions

Functions

isValidAgentKey()

isValidAgentKey(key): boolean

Defined in: types/agents.ts:244

Validate agent key format

Parameters

key

string

Returns

boolean

---

isValidAgentOwnership()

isValidAgentOwnership(organizationId, userId): boolean

Defined in: types/agents.ts:251

Validate XOR constraint: exactly one of organization_id, user_id, or both NULL (system)

Parameters

organizationId

string | null | undefined

userId

string | null | undefined

Returns

boolean

---

isSystemAgent()

isSystemAgent(agent): boolean

Defined in: types/agents.ts:265

Check if agent is a system agent (both organization_id and user_id are NULL)

Parameters

agent

Agent

Returns

boolean

---

isOrganizationAgent()

isOrganizationAgent(agent): boolean

Defined in: types/agents.ts:272

Check if agent is an organization agent

Parameters

agent

Agent

Returns

boolean

---

isUserAgent()

isUserAgent(agent): boolean

Defined in: types/agents.ts:279

Check if agent is a user agent

Parameters

agent

Agent

Returns

boolean

---

canTransitionVersionStatus()

canTransitionVersionStatus(from, to): boolean

Defined in: types/agents.ts:299

Check if version status transition is valid

Parameters

from

AgentVersionStatus

to

AgentVersionStatus

Returns

boolean