KOkoncile
Public

Create Agent

Changed on

Create an agent on one or more templates.

Recreates an agent from a saved configuration, so a template backed up outside Koncile can be rebuilt without duplicating an existing one.

Reference data is a second step. A datatable_match agent needs its CSV before it can run, and cannot be activated without one. The full flow is: create_agent (inactive) -> upload_csv -> activate_agent. Types with no reference data (splitting, document_rename, signature, cross_split) can be created active in one call.

fraud agents cannot be created here.

post/v1/create_agent/

Request

Request body

type'compliance' | 'datatable_match' | 'fraud' | 'signature' | 'document_rename' | 'splitting' | 'cross_split' required
template_idsinteger[] required

Templates to link. Exactly one for datatable_match and compliance; at least two for cross_split.

namestring nullable
status'active' | 'inactive'
settingsobject nullable

Type-specific configuration

linked_field_idsinteger[]

Fields the agent should read

Response

Successful Response

idinteger required
type'compliance' | 'datatable_match' | 'fraud' | 'signature' | 'document_rename' | 'splitting' | 'cross_split' required
namestring nullable
status'active' | 'inactive' required
is_lockedboolean nullable
is_show_hintboolean nullable
template_idsinteger[]

Templates this agent is linked to. Exactly one for datatable_match and compliance; at least two for cross_split.

settingsobject nullable

Type-specific configuration. For fraud agents this is filtered: Koncile-internal rules and prompts are not exposed.

linked_field_idsinteger[]

Fields the agent reads

source_agent_idinteger nullable

Read-only provenance if this agent was duplicated

source_agent_namestring nullable
activation_errorstring nullable

Set only on create_agent when status: active was requested but the agent is not yet ready to activate. The agent exists and is inactive; fix the reason and call activate_agent.

Changes