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:

  • 404 AGENT_NOT_FOUND — No agent with this id belongs to the token owner. A deleted agent and another user's agent answer identically.
  • 409 AGENT_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).
  • 422 VALIDATION_FAILED — The request failed this endpoint's own validation — param names the offending field and message says why.
  • 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/{agentId}/stop

Request

  • Base URL: https://api.tryfuse.ai/api/v1
  • URL: https://api.tryfuse.ai/api/v1/business/agents/{agentId}/stop
  • Auth: HTTP basic

Path parameters

agentIdstring required

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

Changes

No recorded changes to this operation across all 1 revision of this API.