Skip to main content

CreateAgentRuntimeRequest

Agent Runtimes

Agent Runtimes / types/agents-lifecycle / CreateAgentRuntimeRequest

Type Alias: CreateAgentRuntimeRequest

CreateAgentRuntimeRequest = object

Defined in: src/types/agents-lifecycle.ts:20

Request payload for creating a new agent runtime.

Properties​

agentSpec?​

optional agentSpec?: Record<string, any>

Defined in: src/types/agents-lifecycle.ts:31

Full agent spec payload to propagate to backend services

agentSpecId?​

optional agentSpecId?: string

Defined in: src/types/agents-lifecycle.ts:29

ID of the agent spec used to create this runtime

billingEntityHandle?​

optional billingEntityHandle?: string

Defined in: src/types/agents-lifecycle.ts:39

Account handle charged for runtime costs.

billingEntityType?​

optional billingEntityType?: "user" | "organization" | "team"

Defined in: src/types/agents-lifecycle.ts:37

Account kind charged for runtime costs.

billingEntityUid?​

optional billingEntityUid?: string

Defined in: src/types/agents-lifecycle.ts:33

Account UID (user or organization) charged for runtime costs

billingSourceOrganizationHandle?​

optional billingSourceOrganizationHandle?: string

Defined in: src/types/agents-lifecycle.ts:43

Source organization handle for team-billed runtimes.

billingSourceOrganizationUid?​

optional billingSourceOrganizationUid?: string

Defined in: src/types/agents-lifecycle.ts:41

Source organization UID for team-billed runtimes.

creditsLimit?​

optional creditsLimit?: number

Defined in: src/types/agents-lifecycle.ts:23

editorVariant?​

optional editorVariant?: string

Defined in: src/types/agents-lifecycle.ts:26

'none', 'notebook', or 'document'

enableCodemode?​

optional enableCodemode?: boolean

Defined in: src/types/agents-lifecycle.ts:27

environmentName?​

optional environmentName?: string

Defined in: src/types/agents-lifecycle.ts:21

givenName?​

optional givenName?: string

Defined in: src/types/agents-lifecycle.ts:22

mountHomeFolder?​

optional mountHomeFolder?: boolean

Defined in: src/types/agents-lifecycle.ts:45

Mount account home folder into runtime.

type?​

optional type?: string

Defined in: src/types/agents-lifecycle.ts:24

userAccountHandle?​

optional userAccountHandle?: string

Defined in: src/types/agents-lifecycle.ts:35

User account handle used for user home mount path.

volumeUid?​

optional volumeUid?: string

Defined in: src/types/agents-lifecycle.ts:47

Optional volume UID to mount into runtime.

volumeUids?​

optional volumeUids?: string[]

Defined in: src/types/agents-lifecycle.ts:49

Optional volume UIDs to mount into runtime.