Skip to content

Start here

Get started with AgentWIFI

Want your agent to research a topic, review product feedback, or follow trends? Pick a way to start and try one task. The API details are further down when you need them.

01 · 01

Connect AgentWIFI to your agent

Once connected, ask for a task as you normally would. Your agent can find a tool through AgentWIFI, check its cost, and get a result.

Step 1 of 3

Ask your agent to set it up

Copy this prompt into the agent you use. It will read the official install guide, check your client and system, and choose the matching setup path. After sending the prompt, watch for the authorization and client confirmation steps below.

Read https://agentwifi.ai/install.md and install AgentWIFI for this agent only.
Read the full installation steps

Step 2 of 3

Authorize and confirm in your client

Your agent may open a browser sign-in page or show an authorization URL and one-time code. Complete the steps in your browser yourself; you do not need to send an API key in chat. Some clients have one more step:

If you use Codex

With native MCP login, Codex opens a browser. Sign in to AgentWIFI and approve access, then return to Codex. If it only says the server was added, ask Codex to complete AgentWIFI login. If it uses the installer instead, follow the authorization URL and one-time code it displays.

If you use WorkBuddy

After browser authorization, open WorkBuddy, click 「Experts·Skills·Connectors」 (专家·技能·连接器) in the top-left menu, open Connectors (连接器), click Custom Connectors (自定义连接器) at the top right, then find AgentWIFI (the installer already added it) and select Trust. If it already shows Trusted, continue. You must confirm this inside WorkBuddy. Then start a new task or reload the window.

Using another agent? Follow its install guide and authorization prompts, then start a new session. Tools may not appear in the session that was open during installation.

Step 3 of 3

Start a new session and try a task

After authorization and any client trust step, start a new conversation or task. Copy the request below; you do not need to remember tool names.

Use AgentWIFI to find a few recent AI news stories. Check the tool and cost before searching, then include links to the original sources.

If your agent returns search results with source links, it is ready to use. If it cannot find AgentWIFI tools, check browser or installer authorization in Codex, or connector trust in WorkBuddy. For other clients, check the install guide and start a new session.

01 · 02

Which agents can connect?

The clients below have installation steps. Setup differs by client; follow the complete install guide for yours.

In Codex, Claude Code, Gemini CLI, or Kimi CLI, try browser authorization first. For the other listed clients, follow the device authorization steps in the install guide.

Supported agents

  • Codex
  • Claude Code
  • Cursor
  • Gemini CLI
  • OpenCode
  • OpenClaw
  • Hermes
  • Qoder
  • WorkBuddy
  • Kimi CLI
  • Kiro
  • Windsurf
  • ZCode

Operating systems: macOS, Linux, Windows

Do not see your agent? Check the install guide before trying another client’s configuration.

01 · 03

Find the tool you need

This catalog covers tools for the web, social media, ecommerce, and more. Start with your task, then check each tool's name and billing unit.

Use the categories and search box to narrow the list, then select “Show a few more” to keep browsing. If you are writing an app, you can fetch the full list through the REST API.

Find tools by use

These tools are in the published catalog. Some may be temporarily unavailable. Check current status, required inputs, and cost before you run one.

Filter by tool category
231 found
  • Google Trends research

    web.seo.google_trends

    Web and search · 4 credits / result

  • Keyword Planner keyword metrics

    web.seo.keyword_planner.get_metrics

    Web and search · 13 credits / result

  • Keyword Planner keyword ideas

    web.seo.keyword_planner.get_ideas

    Web and search · 13 credits / result

  • Keyword Planner metrics or ideas

    web.seo.keyword_planner

    Web and search · 13 credits / result

  • Ahrefs website authority

    web.seo.ahrefs.get_web_authority

    Web and search · 11 credits / result

  • Ahrefs website traffic

    web.seo.ahrefs.get_traffic

    Web and search · 11 credits / result

  • Ahrefs AI Overview

    web.seo.ahrefs.get_ai_overview

    Web and search · 11 credits / result

  • Ahrefs AI Mode

    web.seo.ahrefs.get_ai_mode

    Web and search · 11 credits / result

How to use it in an agent

Tell your agent what you need. For example: “Read this page and pull out the main points.” It should find a suitable tool, check the required inputs, cost, and current status, then run it. If there are more results, ask it to continue.

Help me read a web page with AgentWIFI. Tell me what you need and how many credits it may cost, then ask for the link and summarize the page.

01 · 04

Use a Skill for common tasks

A Skill is a task guide for your agent. It lays out the steps for jobs such as summarizing product reviews, checking hot lists, or comparing prices.

What does a Skill save you?

You do not need to plan every step. A Skill tells your agent what to ask for, which tools to use, how many items to check, and how to present the result. It still uses AgentWIFI capabilities.

How to start

Connect AgentWIFI to your agent, then name the Skill you want to use. Your agent can read its guide from the store. If the Skill needs local files, follow the store’s installation steps. Confirm the required inputs, cost, and item limit before you begin.

Use AgentWIFI’s amazon-review-digest Skill to summarize reviews for an Amazon product. Tell me what you need, the estimated cost, and the maximum number of reviews first, then ask me for the ASIN.

ASIN is an Amazon product identifier. Other Skills may need different inputs.

Skills available now

These Skills are currently published. Open the store for details and installation steps.

  • AgentWIFI Reddit Monitor

    Monitor Reddit keywords, deduplicate matches, and surface opportunities.

    agentwifi-reddit-monitor · Install locally

  • AgentWIFI Brand Mention Tracking

    Track direct public mentions of a brand or competitor.

    agentwifi-track-brand-mentions · Install locally

  • Amazon Review Digest

    Summarize Amazon product reviews by ASIN.

    amazon-review-digest · Load directly

  • Bilibili Hot Videos

    Read current Bilibili hot-search topics.

    bilibili-hot-videos · Load directly

  • Douyin Hot Trends

    Read Douyin hot-search and ranking lists.

    douyin-hot-trends · Load directly

  • Multi-Platform Price Compare

    Compare a product's prices across ecommerce platforms.

    multi-platform-price-compare · Load directly

  • Reddit Hot Posts

    Fetch current hot posts on Reddit.

    reddit-hot-posts · Load directly

  • TikTok Trending Scan

    Fetch TikTok trending search terms.

    tiktok-trending-scan · Load directly

  • WeChat Article Research

    Find public WeChat articles and summarize them.

    wechat-article-research · Load directly

  • Weibo Hot Search

    Read current Weibo hot searches.

    weibo-hot-search · Load directly

  • Xiaohongshu Daily Trending

    Read Xiaohongshu hot topics.

    xiaohongshu-daily-trending · Load directly

  • Xiaohongshu Note Comments

    Analyze comments on a public Xiaohongshu note.

    xiaohongshu-note-comments · Load directly

01 · 05

Let your agent use AgentWIFI through MCP

MCP is one way for agents to connect to tools. Once connected, your agent can find tools, check costs, and run them. Browser-authorized clients use https://mcp.agentwifi.ai/v1/mcp; manual API-key setup uses https://agentwifi.ai/v1/mcp.

What happens during a call

For example, when you ask your agent to read a page, it first finds a suitable tool (find_tools), checks its inputs and cost (describe_tool), then runs it (execute_tool). You can follow the same order in your own client.

Tools available after connecting

02

When do you need an API key?

You need an API key when you call AgentWIFI from your own script or service. If you only use it inside an agent and authorize in a browser, you usually do not need to create one.

Where to use it

Use it in server scripts, scheduled jobs, or MCP clients that require manual setup. Keep the key on the server and send Authorization: Bearer YOUR_API_KEY in the request header. Do not put it in frontend code or chat.

Create and keep your key

Create a key in the Console and grant only the permissions you need. Save the key; revoke it there when you stop using it or suspect exposure.

Create an API key

What your key can do

catalog:read
Find tools and read how to use them
account:read
Check your balance and capability status
tools:execute
Run currently available tools

MCP and REST calls draw from the same credits balance and appear in your call records. When you rotate a key, update your app before revoking the old one.

Check your key with this request

curl --fail-with-body --silent --show-error 'https://agentwifi.ai/v1/account' \
  --header 'Authorization: Bearer <YOUR_API_KEY>'

03

Call the REST API from your app

Use HTTP requests from a script or backend service to search tools, check your account, and run tools. Create an API key first, then use the endpoints and examples below.

Try a request

Find a tool first

curl --fail-with-body --silent --show-error 'https://agentwifi.ai/v1/catalog/search?query=latest%20AI%20news&limit=3' \
  --header 'Authorization: Bearer <YOUR_API_KEY>'

Then run a tool

curl --fail-with-body --silent --show-error 'https://agentwifi.ai/v1/execute' \
  --header 'Authorization: Bearer <YOUR_API_KEY>' \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{"canonicalName":"web.search","params":{"query":"latest AI news"},"maxCredits":"1","idempotencyKey":"docs-web-search-001"}'

04

What to do when a call fails

Find the error code in the response and follow the suggestion below. If you report the issue, include the request ID (X-Request-Id) so the call can be located.

{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Request rate limit exceeded",
    "retryAfterMs": 1000,
    "scope": "api_key_rate"
  },
  "requestId": "req_example_01"
}
VALIDATION_ERROR400
An input is missing or invalid. Check fieldErrors in the response for the exact field, then retry.
UNAUTHENTICATED401
The API key is missing or no longer valid. Check your configuration or create a new key in the Console.
INSUFFICIENT_CREDITS402
Your credits balance is too low. Check the balance and top up in the Console.
FORBIDDEN403
This key does not have the required permission. Create one with the permission you need.
NOT_FOUND404
The tool or resource was not found. Search again and check the tool name.
TOOL_UNAVAILABLE409
This tool cannot be run right now. Try again later or find another tool for the task.
RATE_LIMITED429
Too many requests. Check retryAfterMs and wait the specified time before retrying.
CANCELLED499
The client cancelled the request. Send it again if you still need a result.
UPSTREAM_TIMEOUT504
The data source timed out. Try again later.
UPSTREAM_UNAVAILABLE502
The data source is temporarily unavailable. The system will try a backup route; retry later if it still fails.
CATALOG_UNAVAILABLE503
The tool catalog is temporarily unavailable. Try again later.
DEADLINE_EXCEEDED504
The request took too long. Narrow the task and retry.
INTERNAL_ERROR500
The server ran into a problem. Contact us with the request ID.
AgentWIFI documentation | AgentWIFI