HTTP API
AgentDefinitionRequest
Request to create or update an agent definition.
Shape: object
| Property | Required | Type | Description | Rules |
|---|---|---|---|---|
name |
yes | string |
Agent name. Unique within the catalog. | — |
displayName |
no | string |
Name shown in the UI. | — |
description |
no | string |
Short description. | — |
instructions |
no | string |
System instructions. | — |
instructionsByCulture |
no | object |
Culture-keyed instructions. See IReadOnlyDictionary<string, string>? AgentDefinition.InstructionsByCulture. | — |
model |
yes | ModelBinding |
Model binding: provider, model, and sampling settings. | — |
toolNames |
no | array of string |
Names of tools to use. Tools are defined only in code; only the name of an already registered tool may be given here. | — |
skillNames |
no | array of string |
Names of skills that can be loaded at runtime. | — |
skills |
no | null oneOf SkillSettings |
— | — |
workspace |
no | null oneOf WorkspaceSettings |
— | — |
extensionNames |
no | array of string |
Names of agent extensions to compile the agent with, in call order. Extensions are defined only in code; only the name of an already registered extension may be given here. See AgentDefinition.ExtensionNames. |
— |
callableAgents |
no | array of CallableAgentReference |
The other agents this agent may call, each with the version of it that runs. | — |
subAgents |
no | null oneOf SubAgentSettings |
— | — |
mcpResourceUris |
no | array of string |
MCP resources added to the run context, each of the form "{server}:{uri}". See AgentDefinition.McpResourceUris. |
— |
harness |
no | null oneOf HarnessSettings |
— | — |
compaction |
no | null oneOf CompactionSettings |
— | — |
memory |
no | null oneOf MemorySettings |
— | — |
metadata |
no | object |
Free-form, application-specific metadata. See AgentDefinition.Metadata. |
— |
parameters |
no | array of AgentParameter |
The parameter schema. See IReadOnlyList<AgentParameter> AgentDefinition.Parameters. | — |
sharedInstructionsName |
no | string |
The referenced shared instructions block. See AgentDefinition.SharedInstructionsName. |
— |