ShadAI Framework
  1. api-reference
ShadAI Framework
  • Index
  • README
  • Pricing
    • Pricing Plan
  • advanced
    • Best Practices
    • Tool Orchestration
    • Performance Optimization
    • Custom Tools
  • examples
    • Advanced Patterns
    • Custom Agent Examples
    • Market Research Examples
    • Multi-Document Analysis
    • Basic Query Examples
  • api-reference
    • Exceptions Reference
    • Engine Tool API
    • Shadai Client API Reference
    • Query Tool API
    • Summarize Tool API
    • Agent Tool API
    • Web Search Tool API
  • use-cases
    • Knowledge Synthesis
    • Research Assistant
    • Custom Workflows
    • Document Q&A
  • core-concepts
    • Architecture
    • Intelligent Agent
    • RAG System
    • Tools Overview
  • guides
    • Memory & Context
    • Streaming Responses
    • File Ingestion
    • Error Handling
    • Session Management
  • getting-started
    • Authentication
    • Your First Query
    • Quick Start
    • Installation
  1. api-reference

Agent Tool API

Execute custom workflows with your own tools.

Method Signature#

Parameters#

prompt (str, required): Task description
tools (List[Callable], required): List of tool functions

Returns#

Async iterator yielding response chunks (strings)

Creating Tools#

Using @tool Decorator#

Tool Requirements#

Must use @tool decorator
Must have docstring
Must have type hints
Must return string

Example#

See Also#

Intelligent Agent
Custom Tools Guide
Modified at 2025-10-17 17:46:10
Previous
Summarize Tool API
Next
Web Search Tool API
Built with