v3

latestOpenAPI 3.1.0Proprietary2026-08-07266348629.6 KB
Agents

Create Agent From Config

Create a config-based agent, optionally deploying it.

Set deploy=false to save as draft without deploying.

post/agents/config

Query parameters

deployboolean

Request body

namestring required

Agent display name

descriptionstring nullable

Human-readable context for the agent

enabledboolean

Kill switch. When false, the Flink runtime accepts the deploy but stops emitting output — used by support to disable a runaway tenant agent without a full cancel/redeploy.

agentType'workflow' | 'react'

Response

Successful Response

_idstring required
namestring required
job_type'pyflink' | 'jar' | 'agent_config' | 'knowledge_base' required
status'CREATED' | 'DEPLOYING' | 'RUNNING' | 'CANCELLING' | 'CANCELLED' | 'FAILED' | 'FINISHED' required
desired_status'CREATED' | 'DEPLOYING' | 'RUNNING' | 'CANCELLING' | 'CANCELLED' | 'FAILED' | 'FINISHED'
flink_job_namestring required
flink_job_idstring nullable
parallelisminteger
error_messagestring nullable
agent_configobject nullable
created_bystring nullable
created_timestampstring date-time nullable
updated_timestampstring date-time nullable