Skip to main content
PUT
Update Agent Config

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

job_id
string
required

Body

application/json

Request body for PUT /agents/{id}/config - update agent config and redeploy.

description
string | null

Human-readable context for the agent

Maximum string length: 500
enabled
boolean | null

Kill switch — set false to disable output emission without cancel/redeploy.

input
AgentInputConfig · object | null

Input configuration for the agent.

output
AgentOutputConfig · object | null

Output configuration for the agent.

llm
AgentLlmConfig · object | null

Inline LLM configuration embedded on the agent.

Carries provider, credentials, model, and tuning controls as a single blob. The FE prefills the form from a saved :class:AgentLlmConnection (which now carries default model + tuning + reasoning controls) and the user can override per-agent before save; the resulting blob is stored verbatim and shipped to the Flink runtime at deploy.

Two credential shapes (XOR, mirrors :class:ValidateLlmRequest):

  1. Inline - apiKey is filled directly. The BE KMS-encrypts it at save and decrypts it at deploy / test-run.
  2. Linked - llmConnectionId references a row in agent_connections.llmConnections and apiKey is left empty. The BE resolves the real key server-side at deploy and at test-run via :func:agents_service.resolve_saved_llm_credentials, so the browser never needs to hold (or re-paste) the stored plaintext when editing an existing agent.

provider == ollama accepts an empty key without a link (the runtime is local and unauthenticated).

prompts
AgentPromptConfig · object | null

Prompt configuration for the agent.

The final system prompt is auto-assembled by build_system_prompt() from the agent type template + output schema + tool descriptions + custom_instructions. The system field stores the assembled result (set by the backend, not the user).

mcpServer
AgentMcpServerConfig · object | null

Top-level MCP server config shared across all MCP tools.

Two shapes (hard cutover):

  • Streamkap MCP (internal toolbelt): projectKeyId set, serverUrl and headers resolved server-side at deploy time from the agentic-enabled Project Key. The legacy "saved Streamkap MCP card" path (match-by-serverUrl against agent_connections.mcpConnections[source==streamkap]) is gone.
  • External MCP: serverUrl + headers set inline; projectKeyId omitted. Headers are still composed at deploy time from the matching saved external connection (bearer / custom-header).
tools
AgentToolConfig · object[] | null
memory
AgentMemoryConfig · object | null

Memory configuration for the agent.

knowledgeBases
AgentKnowledgeBaseRef · object[] | null

Knowledge bases this agent can query at runtime for RAG

Maximum array length: 10
processing
AgentProcessingConfig · object | null

Processing configuration for the agent.

changeNote
string | null
Maximum string length: 500

Response

Successful Response

_id
string
required
name
string
required
job_type
enum<string>
required
Available options:
pyflink,
jar,
agent_config,
knowledge_base
status
enum<string>
required
Available options:
CREATED,
DEPLOYING,
RUNNING,
CANCELLING,
CANCELLED,
FAILED,
FINISHED
desired_status
enum<string> | null
Available options:
CREATED,
DEPLOYING,
RUNNING,
CANCELLING,
CANCELLED,
FAILED,
FINISHED
parallelism
integer
default:1
error_message
string | null
agent_config
Agent Config · object | null
created_by
string | null
created_timestamp
string<date-time> | null
updated_timestamp
string<date-time> | null