From b146d40b62843ae395e4f770a57fd0ca192b0281 Mon Sep 17 00:00:00 2001
From: MervinPraison <454862+MervinPraison@users.noreply.github.com>
Date: Thu, 5 Nov 2026 17:58:28 +0000
Subject: [PATCH] docs: auto-update api.md [skip ci]
---
api.md | 20 ++++++++++----------
1 file changed, 10 insertions(+), 10 deletions(-)
diff --git a/api.md b/api.md
index 5a5dc26c4..6e5ead039 100644
--- a/api.md
+++ b/api.md
@@ -132,17 +132,17 @@ Methods:
* DeepResearchAgent.openai_client()
* DeepResearchAgent.research(query: str, instructions: Optional[str] = None, model: Optional[str] = None, summary_mode: Optional[Literal['auto', 'detailed', 'concise']] = None, web_search: Optional[bool] = None, code_interpreter: Optional[bool] = None, mcp_servers: Optional[List[Dict[str, Any]]] = None, file_ids: Optional[List[str]] = None, file_search: Optional[bool] = None, file_search_stores: Optional[List[str]] = None, stream: bool = True) -> DeepResearchResponse
* DeepResearchAgent.rewrite_query(query: str, model: Optional[str] = None) -> str
-* ImageAgent.achat(prompt: str, temperature: float = 0.2, tools: Optional[List[Any]] = None, output_json: Optional[str] = None, output_pydantic: Optional[Any] = None, reasoning_steps: bool = False, **kwargs) -> Union[str, Dict[str, Any]]
-* ImageAgent.aedit(image: str, prompt: str, mask: Optional[str] = None, n: int = 1, size: Optional[str] = None, **kwargs) -> Dict[str, Any]
-* ImageAgent.agenerate(prompt: str, **kwargs) -> Dict[str, Any]
-* ImageAgent.agenerate_image(prompt: str, **kwargs) -> Dict[str, Any]
-* ImageAgent.avariation(image: str, n: int = 1, size: Optional[str] = None, **kwargs) -> Dict[str, Any]
-* ImageAgent.chat(prompt: str, **kwargs) -> Dict[str, Any]
-* ImageAgent.edit(image: str, prompt: str, mask: Optional[str] = None, n: int = 1, size: Optional[str] = None, **kwargs) -> Dict[str, Any]
-* ImageAgent.generate(prompt: str, **kwargs) -> Dict[str, Any]
-* ImageAgent.generate_image(prompt: str, **kwargs) -> Dict[str, Any]
+* ImageAgent.achat(prompt: str, temperature: float = 0.2, tools: Optional[List[Any]] = None, output_json: Optional[str] = None, output_pydantic: Optional[Any] = None, reasoning_steps: bool = False, **kwargs) -> Union[ImageResult, Dict[str, Any]]
+* ImageAgent.aedit(image: str, prompt: str, mask: Optional[str] = None, n: int = 1, size: Optional[str] = None, **kwargs) -> ImageResult
+* ImageAgent.agenerate(prompt: str, **kwargs) -> ImageResult
+* ImageAgent.agenerate_image(prompt: str, **kwargs) -> ImageResult
+* ImageAgent.avariation(image: str, n: int = 1, size: Optional[str] = None, **kwargs) -> ImageResult
+* ImageAgent.chat(prompt: str, **kwargs) -> Union[ImageResult, Dict[str, Any]]
+* ImageAgent.edit(image: str, prompt: str, mask: Optional[str] = None, n: int = 1, size: Optional[str] = None, **kwargs) -> ImageResult
+* ImageAgent.generate(prompt: str, **kwargs) -> ImageResult
+* ImageAgent.generate_image(prompt: str, **kwargs) -> ImageResult
* ImageAgent.litellm()
-* ImageAgent.variation(image: str, n: int = 1, size: Optional[str] = None, **kwargs) -> Dict[str, Any]
+* ImageAgent.variation(image: str, n: int = 1, size: Optional[str] = None, **kwargs) -> ImageResult
* PlanningAgent.analyze_context(context: str) -> str
* PlanningAgent.analyze_context_sync(context: str) -> str
* PlanningAgent.create_plan(request: str, agents: List['Agent'], tasks: Optional[List['Task']] = None, context: Optional[str] = None) -> Plan