KOkoncile
Public

Activate Agent

Changed on

Activate an agent.

The step that follows create_agent + upload_csv for a datatable_match agent. Refuses with a reason if the agent is not ready — most often because its reference data has not been uploaded, or is still being processed.

post/v1/activate_agent/

Request

Request body

agent_idinteger required

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