Skip to content
Overmind
Get started
API Reference
Agents

Create agent

client.agents.create(AgentCreateParams { name, project, slug, 33 more } body, RequestOptionsoptions?): AgentCreateResponse { id, created_at, name, 36 more }
POST/api/agents/

Create agent

ParametersExpand Collapse
body: AgentCreateParams { name, project, slug, 33 more }
name: string
minLength1
maxLength255
project: string
formatuuid
slug: string
minLength1
maxLength255
active_dataset?: string | null
formatuuid
agent_description?: unknown
agent_path?: string
maxLength512
analyzer_model?: string
maxLength128
backtest_metadata?: unknown
backtest_model_suggestions?: unknown
consistency_rules?: unknown
dataset_has_expected_output?: boolean
dataset_input_keys?: unknown
dataset_size?: number
maximum9223372036854776000
minimum-9223372036854776000
formatint64
description?: string
display_name?: string
maxLength512
entrypoint_fn?: string
maxLength255
eval_dataset?: unknown
evaluation_criteria?: unknown
fixed_elements?: unknown
improvement_metadata?: unknown
input_schema?: unknown
is_deleted?: boolean
model?: string
maxLength128
optimizable_elements?: unknown
output_fields?: unknown
output_schema?: unknown
policy_data?: unknown
policy_markdown?: string
proposed_criteria?: unknown
status?: string
minLength1
maxLength20
structure_weight?: number
formatdouble
tags?: unknown
tool_analysis?: unknown
tool_config?: unknown
tool_usage_weight?: number
formatdouble
total_points?: number
formatdouble
ReturnsExpand Collapse
AgentCreateResponse { id, created_at, name, 36 more }
id: string
formatuuid
created_at: string
formatdate-time
name: string
maxLength255
project: string
formatuuid
slug: string
maxLength255
updated_at: string
formatdate-time
active_dataset?: string | null
formatuuid
agent_description?: unknown
agent_path?: string
maxLength512
analyzer_model?: string
maxLength128
backtest_metadata?: unknown
backtest_model_suggestions?: unknown
consistency_rules?: unknown
dataset_has_expected_output?: boolean
dataset_input_keys?: unknown
dataset_size?: number
maximum9223372036854776000
minimum-9223372036854776000
formatint64
description?: string
display_name?: string
maxLength512
entrypoint_fn?: string
maxLength255
eval_dataset?: unknown
evaluation_criteria?: unknown
fixed_elements?: unknown
improvement_metadata?: unknown
input_schema?: unknown
is_deleted?: boolean
model?: string
maxLength128
optimizable_elements?: unknown
output_fields?: unknown
output_schema?: unknown
policy_data?: unknown
policy_markdown?: string
proposed_criteria?: unknown
status?: string
maxLength20
structure_weight?: number
formatdouble
tags?: unknown
tool_analysis?: unknown
tool_config?: unknown
tool_usage_weight?: number
formatdouble
total_points?: number
formatdouble
Create agent
import OvermindLab from 'overmind-lab';

const client = new OvermindLab();

const agent = await client.agents.create({
  name: 'x',
  project: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  slug: 'slug',
});

console.log(agent.id);
{
  "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
}