Prerequisites
Quick Start — OpenAI Agents SDK
The OpenAI Agents SDK provides a higher-level framework for building agents. Wrap Nimble tools with the@function_tool decorator and the SDK handles the tool-calling loop automatically.
Python
Chat Completions API
For more control over the tool-calling loop, define Nimble tools as OpenAI function schemas and handle calls manually.1. Define the Tool Schema
Python
2. Handle Tool Calls
Python
Node.js Example
Node
Available Tools
Any Nimble SDK method can be exposed as an OpenAI tool. Here are the most common ones:| Tool | SDK Method | Use Case |
|---|---|---|
nimble_search | client.search() | Web search with structured results |
nimble_extract | client.extract() | Extract content from a URL |
nimble_crawl | client.crawl.run() | Crawl an entire site |
nimble_map | client.map() | Discover all URLs on a domain |
Next Steps
Python SDK
Full Python SDK reference — all methods and configuration options
Node SDK
Full Node.js SDK reference with TypeScript support
Search
Web search with depth levels, filtering, and AI answers
LangChain
Pre-built LangChain tools and retrievers for Nimble