Skip to main content

Interface: CreateAgentRequest

Defined in: packages/sdk/src/types/member-types.ts:532

Properties

chatModelConfig?

optional chatModelConfig: ChatModelConfig | null

Defined in: packages/sdk/src/types/member-types.ts:550

null clears the stored config. Both agent request bodies are applied with exclude_unset=True server-side, so an OMITTED key means "leave the stored value alone" — only an explicit null detaches a config from the model family it was keyed to. The generated CreateAgentRequestChatModelConfig is the loose OpenAPI free-form object; typing it as the real union here is what makes a misshapen payload a compile error instead of a 400.


chatModelId

chatModelId: string

Defined in: packages/sdk/src/types/member-types.ts:542


codeInterpreterEnabled?

optional codeInterpreterEnabled: boolean

Defined in: packages/sdk/src/types/member-types.ts:556


description?

optional description: string

Defined in: packages/sdk/src/types/member-types.ts:534


email?

optional email: string

Defined in: packages/sdk/src/types/member-types.ts:535


externalId?

optional externalId: string

Defined in: packages/sdk/src/types/member-types.ts:537


labelIds?

optional labelIds: number[]

Defined in: packages/sdk/src/types/member-types.ts:540


maxDailyActions?

optional maxDailyActions: number

Defined in: packages/sdk/src/types/member-types.ts:554


memberRoleId?

optional memberRoleId: number

Defined in: packages/sdk/src/types/member-types.ts:539

Omitted → backend defaults to the workspace's canonical Agent role (#16207).


memoryConfig?

optional memoryConfig: AgentMemoryConfig

Defined in: packages/sdk/src/types/member-types.ts:557


name

name: string

Defined in: packages/sdk/src/types/member-types.ts:533


ownerId?

optional ownerId: number

Defined in: packages/sdk/src/types/member-types.ts:541


phone?

optional phone: string

Defined in: packages/sdk/src/types/member-types.ts:536


realtimeModelConfig?

optional realtimeModelConfig: Record<string, unknown>

Defined in: packages/sdk/src/types/member-types.ts:552


realtimeModelId?

optional realtimeModelId: string

Defined in: packages/sdk/src/types/member-types.ts:551


systemPrompt

systemPrompt: string

Defined in: packages/sdk/src/types/member-types.ts:553


tools?

optional tools: string[]

Defined in: packages/sdk/src/types/member-types.ts:555