Pause an agent (one-way, there is no resume)
curl --request POST \
--url https://api.tryfuse.ai/api/v1/business/agents/{agentId}/stop \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api.tryfuse.ai/api/v1/business/agents/{agentId}/stop"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.tryfuse.ai/api/v1/business/agents/{agentId}/stop', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"agent": {
"id": "6a8d7a5032fd74700391356b",
"type": "companies-watcher",
"name": "Fundraising Sofiia 25 aug",
"status": "paused",
"config": {
"listName": "Fundraising Sofiia 25 aug",
"eventType": "company-watch-funding-milestones",
"listIds": [
"6a7ef6d7d1d092349bbf5db5"
],
"expirationDate": "2026-08-26",
"frequency": 1,
"maxContacts": 50
},
"isReconstructed": true,
"lossyFields": [],
"sourceLists": [
{
"id": "6a7ef6d7d1d092349bbf5db5",
"name": "tegna_44 - Companies"
}
]
}
}{
"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
Pause an agent (one-way, there is no resume)
Pauses a running agent: its provider subscriptions (for a scrape, its recurring schedule) stop, status becomes paused, and no further results are delivered or billed. Already-delivered rows stay in the results list. This is one-way through the API: activate only accepts drafts, so a paused agent cannot be resumed here; duplicate it and activate the copy instead. A draft has nothing to pause and is refused with 409 AGENT_NOT_RUNNING (pausing one would strand it: activate takes drafts only). An agent that has already expired can still be paused and answers 200. Answers 200 with the agent as GET returns it.
Errors:
404AGENT_NOT_FOUND— No agent with this id belongs to the token owner. A deleted agent and another user’s agent answer identically.409AGENT_NOT_RUNNING— The agent has nothing to pause: it is still a draft (initializing), or its provider subscription is already gone. Drafts are refused deliberately, because a paused draft could never be started again (activate accepts drafts only).422VALIDATION_FAILED— The request failed this endpoint’s own validation —paramnames the offending field andmessagesays why.429RATE_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 theRetry-Afterheader.500UNEXPECTED_ERROR— The agents service failed (5xx, refused service credential, or a timeout after 60s) or the rate limiter was unavailable. Retry later; quoterequest_idto support.
Requires one of the following token scopes: agents.
POST
/
business
/
agents
/
{agentId}
/
stop
Pause an agent (one-way, there is no resume)
curl --request POST \
--url https://api.tryfuse.ai/api/v1/business/agents/{agentId}/stop \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api.tryfuse.ai/api/v1/business/agents/{agentId}/stop"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.tryfuse.ai/api/v1/business/agents/{agentId}/stop', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"agent": {
"id": "6a8d7a5032fd74700391356b",
"type": "companies-watcher",
"name": "Fundraising Sofiia 25 aug",
"status": "paused",
"config": {
"listName": "Fundraising Sofiia 25 aug",
"eventType": "company-watch-funding-milestones",
"listIds": [
"6a7ef6d7d1d092349bbf5db5"
],
"expirationDate": "2026-08-26",
"frequency": 1,
"maxContacts": 50
},
"isReconstructed": true,
"lossyFields": [],
"sourceLists": [
{
"id": "6a7ef6d7d1d092349bbf5db5",
"name": "tegna_44 - Companies"
}
]
}
}{
"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
Your API token (af_…) as the Basic-auth username, with an empty password.
Path Parameters
The agent's id: a 24-character hex string — the id of an item from GET /business/agents, or the agent.id a create or duplicate returned.
Response
Success
Show child attributes
Show child attributes