> ## Documentation Index > Fetch the complete documentation index at: https://docs.fuseai.com/llms.txt > Use this file to discover all available pages before exploring further. # Create a web monitor agent > 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. ## OpenAPI ````yaml /openapi.json post /business/agents/web-monitor openapi: 3.1.0 info: title: Fuse Business API version: 1.0.0 description: >- External API for lists, campaigns, prospect search and contacts. Authenticate with your API token as HTTP Basic. All paths are under /api/v1. servers: - url: https://api.tryfuse.ai/api/v1 description: Production security: - basicAuth: [] tags: - name: Lists - name: Custom columns - name: Smart columns - name: Exports - name: Campaigns - name: Knowledge hubs - name: Analytics - name: Website intent - name: Account - name: Prospect search - name: Campaign steps - name: Scheduled sends - name: Campaign templates - name: Agents - name: Research - name: Company search - name: Saved searches - name: Folders - name: Contacts paths: /business/agents/web-monitor: post: tags: - Agents summary: Create a web monitor agent description: >- 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. operationId: createWebMonitorAgent requestBody: required: true content: application/json: schema: type: object properties: start: type: boolean default: false description: >- true creates AND activates the agent (spends credits); false (default) saves a draft to activate later. listName: type: string minLength: 1 description: >- 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: type: string enum: - person - company description: >- What the monitor should find: 'person' for people, 'company' for companies. prompt: type: string minLength: 1 maxLength: 2000 description: >- 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: type: string enum: - 1h - 6h - 1d - 7d description: >- How often the search re-runs — use one of exactly: 1h, 6h, 1d, 7d. Defaults to 1d. numResults: type: integer minimum: 1 maximum: 100 description: >- Web pages to read per run (1-100, defaults to 10). This caps PAGES, not results — one page can yield several matches. maxContacts: type: integer description: >- Cap on the total number of results this agent delivers into its list. Omit for no cap. maxCreditSpend: type: integer minimum: 1000 maximum: 200000 description: >- 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: type: - string - 'null' description: >- 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. required: - listName - entityType - prompt responses: '201': description: Success headers: RateLimit-Limit: schema: type: integer description: Requests permitted in the current window. RateLimit-Remaining: schema: type: integer description: Requests remaining in the current window. RateLimit-Reset: schema: type: integer description: Seconds until the current window resets. content: application/json: schema: type: object required: - agent properties: agent: type: object required: - id - type - name - status - started properties: id: type: string description: >- The new agent's id — pass it as `{agentId}` to every other agent operation. type: type: string enum: - web-monitor description: >- The agent kind that was created — always this endpoint's own slug. name: type: string description: >- The agent's name, echoed from `listName`; also the name of the results list it delivers into. status: type: string enum: - initializing - processing - active description: >- `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: type: boolean description: >- Echoes the `start` you sent: false = a draft that still has to be activated; true = already running and already billing. example: agent: id: 6a8dce4e65fd738c00d8927a type: web-monitor name: Regulator fines 2026 status: initializing started: false '400': description: Error content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Error content: application/json: schema: $ref: '#/components/schemas/Error' '402': description: Error content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Error content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Error content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: Error content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Error content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Error content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Error content: application/json: schema: $ref: '#/components/schemas/Error' security: - basicAuth: [] components: schemas: Error: type: object properties: error: type: object properties: code: type: string message: type: string param: type: - string - 'null' doc_url: type: - string - 'null' request_id: type: - string - 'null' required: - code - message required: - error securitySchemes: basicAuth: type: http scheme: basic description: >- Your API token (`af_…`) as the Basic-auth username, with an empty password. ````