Skip to content
Overmind
Get started
API Reference
Agents

Update agent

PATCH/api/agents/{id}/

Update agent

Path ParametersExpand Collapse
id: string
formatuuid
Body ParametersExpand Collapse
active_dataset: optional string
formatuuid
agent_description: optional unknown
agent_path: optional string
maxLength512
analyzer_model: optional string
maxLength128
backtest_metadata: optional unknown
backtest_model_suggestions: optional unknown
consistency_rules: optional unknown
dataset_has_expected_output: optional boolean
dataset_input_keys: optional unknown
dataset_size: optional number
maximum9223372036854776000
minimum-9223372036854776000
formatint64
description: optional string
display_name: optional string
maxLength512
entrypoint_fn: optional string
maxLength255
eval_dataset: optional unknown
evaluation_criteria: optional unknown
fixed_elements: optional unknown
improvement_metadata: optional unknown
input_schema: optional unknown
is_deleted: optional boolean
model: optional string
maxLength128
name: optional string
minLength1
maxLength255
optimizable_elements: optional unknown
output_fields: optional unknown
output_schema: optional unknown
policy_data: optional unknown
policy_markdown: optional string
project: optional string
formatuuid
proposed_criteria: optional unknown
slug: optional string
minLength1
maxLength255
status: optional string
minLength1
maxLength20
structure_weight: optional number
formatdouble
tags: optional unknown
tool_analysis: optional unknown
tool_config: optional unknown
tool_usage_weight: optional number
formatdouble
total_points: optional number
formatdouble
ReturnsExpand Collapse
id: string
formatuuid
created_at: string
formatdate-time
name: string
maxLength255
project: string
formatuuid
slug: string
maxLength255
updated_at: string
formatdate-time
active_dataset: optional string
formatuuid
agent_description: optional unknown
agent_path: optional string
maxLength512
analyzer_model: optional string
maxLength128
backtest_metadata: optional unknown
backtest_model_suggestions: optional unknown
consistency_rules: optional unknown
dataset_has_expected_output: optional boolean
dataset_input_keys: optional unknown
dataset_size: optional number
maximum9223372036854776000
minimum-9223372036854776000
formatint64
description: optional string
display_name: optional string
maxLength512
entrypoint_fn: optional string
maxLength255
eval_dataset: optional unknown
evaluation_criteria: optional unknown
fixed_elements: optional unknown
improvement_metadata: optional unknown
input_schema: optional unknown
is_deleted: optional boolean
model: optional string
maxLength128
optimizable_elements: optional unknown
output_fields: optional unknown
output_schema: optional unknown
policy_data: optional unknown
policy_markdown: optional string
proposed_criteria: optional unknown
status: optional string
maxLength20
structure_weight: optional number
formatdouble
tags: optional unknown
tool_analysis: optional unknown
tool_config: optional unknown
tool_usage_weight: optional number
formatdouble
total_points: optional number
formatdouble
Update agent
curl https://api.overmindlab.ai/api/agents/$ID/ \
    -X PATCH
{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "created_at": "2019-12-27T18:11:19.117Z",
  "name": "name",
  "project": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "slug": "slug",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "active_dataset": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "agent_description": {},
  "agent_path": "agent_path",
  "analyzer_model": "analyzer_model",
  "backtest_metadata": {},
  "backtest_model_suggestions": {},
  "consistency_rules": {},
  "dataset_has_expected_output": true,
  "dataset_input_keys": {},
  "dataset_size": -9007199254740991,
  "description": "description",
  "display_name": "display_name",
  "entrypoint_fn": "entrypoint_fn",
  "eval_dataset": {},
  "evaluation_criteria": {},
  "fixed_elements": {},
  "improvement_metadata": {},
  "input_schema": {},
  "is_deleted": true,
  "model": "model",
  "optimizable_elements": {},
  "output_fields": {},
  "output_schema": {},
  "policy_data": {},
  "policy_markdown": "policy_markdown",
  "proposed_criteria": {},
  "status": "status",
  "structure_weight": 0,
  "tags": {},
  "tool_analysis": {},
  "tool_config": {},
  "tool_usage_weight": 0,
  "total_points": 0
}
Returns Examples
{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "created_at": "2019-12-27T18:11:19.117Z",
  "name": "name",
  "project": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "slug": "slug",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "active_dataset": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "agent_description": {},
  "agent_path": "agent_path",
  "analyzer_model": "analyzer_model",
  "backtest_metadata": {},
  "backtest_model_suggestions": {},
  "consistency_rules": {},
  "dataset_has_expected_output": true,
  "dataset_input_keys": {},
  "dataset_size": -9007199254740991,
  "description": "description",
  "display_name": "display_name",
  "entrypoint_fn": "entrypoint_fn",
  "eval_dataset": {},
  "evaluation_criteria": {},
  "fixed_elements": {},
  "improvement_metadata": {},
  "input_schema": {},
  "is_deleted": true,
  "model": "model",
  "optimizable_elements": {},
  "output_fields": {},
  "output_schema": {},
  "policy_data": {},
  "policy_markdown": "policy_markdown",
  "proposed_criteria": {},
  "status": "status",
  "structure_weight": 0,
  "tags": {},
  "tool_analysis": {},
  "tool_config": {},
  "tool_usage_weight": 0,
  "total_points": 0
}