--- title: "Create a web monitor agent" method: POST path: "/business/agents/web-monitor" tags: ["Agents"] --- # Create a web monitor agent `POST /business/agents/web-monitor` ## Request - Base URL: `https://api.tryfuse.ai/api/v1` - URL: `https://api.tryfuse.ai/api/v1/business/agents/web-monitor` - Auth: HTTP basic Creates a Website monitor agent (`web-monitor`). Runs a natural-language web search every `searchPeriod` (default daily) over up to `numResults` pages and delivers matching people or companies (`entityType`); each delivered result costs 50 credits and `maxCreditSpend` bounds a run. With `start: false` (the default) a DRAFT is saved — status `initializing`, nothing billed: read it back with GET /business/agents/{agentId}, adjust it with PATCH /business/agents/{agentId}, then start it with POST /business/agents/{agentId}/activate. With `start: true` the agent is created AND started in one call: its dedicated results list is created, credits are checked and spent, and the provider subscriptions are set up. Either way the answer is 201 `{ agent: { id, type, name, status, started } }` — the same shape for every agent kind, draft or started. Poll GET /business/agents for `status` and `contactsFound`, and read the delivered rows with the Lists endpoints via the agent's `listId`. Free-plan accounts hold at most 10 agents, drafts included (403 AGENT_LIMIT_REACHED). Every field below is validated by the agents service: a rejected field answers 422 VALIDATION_FAILED, naming it in `param` and describing every failure in `message`. `listName` must not collide with an existing list or agent name (409 LIST_NAME_TAKEN), and starting without enough credits answers 402 INSUFFICIENT_CREDITS without creating anything. Errors: - `422` `VALIDATION_FAILED` — The request was rejected by validation. Either this endpoint's own request validation (a malformed body), or the agent config itself: a field missing, out of range or not one of the accepted values, or a business rule broken (an `expirationDate` that is not in the future, more industries than the kind accepts, a notification count out of range). `param` names the first offending field and `message` lists every failure. - `409` `LIST_NAME_TAKEN` — `listName` is already used by one of your lists or agents. Pick another name. - `402` `INSUFFICIENT_CREDITS` — The workspace does not have enough credits to start this agent. Nothing was created or spent. - `403` `AGENT_LIMIT_REACHED` — Free-plan accounts may hold at most 10 agents, drafts included. Delete an agent or upgrade the plan. - `422` `AGENT_SIGNAL_REJECTED` — web-monitor only: the search provider refused the `prompt` as a searchable signal. Rewrite the prompt rather than retrying it. - `400` `INVALID_REQUEST` — The agents service rejected the request for a reason this API does not model specifically. The request is not retryable unchanged. - `429` `RATE_LIMITED` — The agents bucket is exhausted: 30 requests per minute or 2,000 per day per token owner, shared by every /business/agents operation (a 429 raised by the agents service is relayed with this code too). Retry after the `Retry-After` header. - `500` `UNEXPECTED_ERROR` — The agents service failed (5xx, refused service credential, or a timeout after 60s) or the rate limiter was unavailable. Retry later; quote `request_id` to support. Requires one of the following token scopes: agents. ## Request body - object - `start` boolean: true creates AND activates the agent (spends credits); false (default) saves a draft to activate later. - `listName` string, required: Name for BOTH the agent and the results list it creates. Must be unique across your agents: a name already in use is rejected with 409 LIST_NAME_TAKEN. - `entityType` 'person' | 'company', required: What the monitor should find: 'person' for people, 'company' for companies. - `prompt` string, required: Plain-language description of the signal to watch for on the open web (e.g. 'companies fined by a regulator over late supplier payments'). Including the year — 'in 2026' — materially improves recency. - `searchPeriod` '1h' | '6h' | '1d' | '7d': How often the search re-runs — use one of exactly: 1h, 6h, 1d, 7d. Defaults to 1d. - `numResults` integer: Web pages to read per run (1-100, defaults to 10). This caps PAGES, not results — one page can yield several matches. - `maxContacts` integer: Cap on the total number of results this agent delivers into its list. Omit for no cap. - `maxCreditSpend` integer: Maximum credits this agent may spend in a single run or refresh (1000 to 200000); delivery-driven monitors stop once their total delivered results reach it. Omit for no limit. - `expirationDate` string, nullable: Date the agent stops running, as YYYY-MM-DD (for example "2026-12-31"), and in the future. Pass null to run until you pause or delete it; omit it for the default of one month from creation. ## Response `201` Success - object - `agent` object, required - `id` string, required: The new agent's id — pass it as `{agentId}` to every other agent operation. - `type` 'web-monitor', required: The agent kind that was created — always this endpoint's own slug. - `name` string, required: The agent's name, echoed from `listName`; also the name of the results list it delivers into. - `status` 'initializing' | 'processing' | 'active', required: `initializing` when `start` was false (a draft). When `start` was true, the agent's real status right after starting: `processing` while the provider setup and first run are under way, `active` once it is running. - `started` boolean, required: Echoes the `start` you sent: false = a draft that still has to be activated; true = already running and already billing. ## Other responses - `400`: Error - `401`: Error - `402`: Error - `403`: Error - `404`: Error - `409`: Error - `422`: Error - `429`: Error - `500`: Error --- [API](https://skmtc.dev/fuseai/apis/fuse-business-api.md) · [All operations](https://skmtc.dev/fuseai/apis/fuse-business-api/llms.txt) · [OpenAPI document](https://skmtc.dev/fuseai/apis/fuse-business-api/revisions/50d95e0536f4?raw)