Skip to main content

AgentConfig

Agent Runtimes

Agent Runtimes / types/config / AgentConfig

Interface: AgentConfig

Defined in: src/types/config.ts:37

Configuration for creating an agent on a runtime.

Properties​

agentLibrary?​

optional agentLibrary?: AgentLibrary

Defined in: src/types/config.ts:47

Agent library (defaults to pydantic-ai).

agentSpecId?​

optional agentSpecId?: string

Defined in: src/types/config.ts:51

Optional agent spec ID for server-side spec-based creation.

createPayload?​

optional createPayload?: Record<string, unknown>

Defined in: src/types/config.ts:65

Additional raw request fields merged into POST /api/v1/agents payload.

description?​

optional description?: string

Defined in: src/types/config.ts:41

Agent description.

enableCodemode?​

optional enableCodemode?: boolean

Defined in: src/types/config.ts:59

Enable codemode if supported by the selected spec/runtime.

enableSkills?​

optional enableSkills?: boolean

Defined in: src/types/config.ts:55

Enable skills for this agent.

inferenceProvider?​

optional inferenceProvider?: string

Defined in: src/types/config.ts:57

Optional inference provider override (e.g. local, datalayer).

jupyterSandbox?​

optional jupyterSandbox?: string

Defined in: src/types/config.ts:63

Optional Jupyter sandbox URL for jupyter-backed sandbox mode.

model?​

optional model?: string

Defined in: src/types/config.ts:43

AI model to use.

name?​

optional name?: string

Defined in: src/types/config.ts:39

Agent name/ID (defaults to runtime pod name).

protocol?​

optional protocol?: Protocol

Defined in: src/types/config.ts:49

Transport protocol (defaults to ag-ui).

sandboxVariant?​

optional sandboxVariant?: string

Defined in: src/types/config.ts:61

Optional sandbox variant (e.g. eval, jupyter, kaggle).

systemPrompt?​

optional systemPrompt?: string

Defined in: src/types/config.ts:45

System prompt for the agent.

tools?​

optional tools?: unknown[]

Defined in: src/types/config.ts:53

Optional custom tools payload.