Create a web monitor agent

curl --request POST \
  --url https://api.tryfuse.ai/api/v1/business/agents/web-monitor \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "listName": "<string>",
  "prompt": "<string>"
}
'

import requests

url = "https://api.tryfuse.ai/api/v1/business/agents/web-monitor"

payload = {
    "listName": "<string>",
    "prompt": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({listName: '<string>', prompt: '<string>'})
};

fetch('https://api.tryfuse.ai/api/v1/business/agents/web-monitor', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "agent": {
    "id": "6a8dce4e65fd738c00d8927a",
    "type": "web-monitor",
    "name": "Regulator fines 2026",
    "status": "initializing",
    "started": false
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

Agents

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/, adjust it with PATCH /business/agents/, then start it with POST /business/agents//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.

POST

business

agents

web-monitor

Create a web monitor agent

curl --request POST \
  --url https://api.tryfuse.ai/api/v1/business/agents/web-monitor \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "listName": "<string>",
  "prompt": "<string>"
}
'

import requests

url = "https://api.tryfuse.ai/api/v1/business/agents/web-monitor"

payload = {
    "listName": "<string>",
    "prompt": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({listName: '<string>', prompt: '<string>'})
};

fetch('https://api.tryfuse.ai/api/v1/business/agents/web-monitor', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "agent": {
    "id": "6a8dce4e65fd738c00d8927a",
    "type": "web-monitor",
    "name": "Regulator fines 2026",
    "status": "initializing",
    "started": false
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Your API token (af_…) as the Basic-auth username, with an empty password.

Body

application/json

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.

Minimum string length: 1

entityType

enum<string>

required

What the monitor should find: 'person' for people, 'company' for companies.

Available options:

person,

company

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.

Required string length: 1 - 2000

start

boolean

default:false

true creates AND activates the agent (spends credits); false (default) saves a draft to activate later.

searchPeriod

enum<string>

How often the search re-runs — use one of exactly: 1h, 6h, 1d, 7d. Defaults to 1d.

Available options:

1h,

6h,

1d,

7d

numResults

integer

Web pages to read per run (1-100, defaults to 10). This caps PAGES, not results — one page can yield several matches.

Required range: 1 <= x <= 100

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.

Required range: 1000 <= x <= 200000

expirationDate

string | null

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

Success

agent

object

required

Show child attributes

Lists

Custom columns

Smart columns

Exports

Campaigns

Campaign steps

Knowledge hubs

Analytics

Website intent

Account

Data

Prospect search

Scheduled sends

Campaign templates

Agents

Research

Company search

Saved searches

Folders

Contacts

Create a web monitor agent

Authorizations

Body

Response