API Reference

Agents

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get agent eval spec

client.agents.retrieveEvalSpec(stringid, RequestOptionsoptions?): AgentRetrieveEvalSpecResponse { agent_description, agent_path, consistency_rules, 8 more }

GET/api/agents/{id}/eval_spec/

Get agent eval spec

ParametersExpand Collapse

id: string

formatuuid

ReturnsExpand Collapse

AgentRetrieveEvalSpecResponse { agent_description, agent_path, consistency_rules, 8 more }

agent_description: string

agent_path: string

consistency_rules: unknown

fixed_elements: unknown

input_schema: unknown

optimizable_elements: unknown

output_fields: unknown

structure_weight: number

formatdouble

tool_config: unknown

tool_usage_weight: number

formatdouble

total_points: number

formatdouble

Get agent eval spec

TypeScript

HTTP

TypeScript

Python

import OvermindLab from 'overmind-lab';

const client = new OvermindLab();

const response = await client.agents.retrieveEvalSpec('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(response.agent_description);

200 example

{
  "agent_description": "agent_description",
  "agent_path": "agent_path",
  "consistency_rules": {},
  "fixed_elements": {},
  "input_schema": {},
  "optimizable_elements": {},
  "output_fields": {},
  "structure_weight": 0,
  "tool_config": {},
  "tool_usage_weight": 0,
  "total_points": 0
}

Returns Examples

200 example

{
  "agent_description": "agent_description",
  "agent_path": "agent_path",
  "consistency_rules": {},
  "fixed_elements": {},
  "input_schema": {},
  "optimizable_elements": {},
  "output_fields": {},
  "structure_weight": 0,
  "tool_config": {},
  "tool_usage_weight": 0,
  "total_points": 0
}